profectus-docs/assets/guide_index.md.71453628.js

1 line
5.3 KiB
JavaScript

import{_ as e,c as o,o as t,a as n}from"./app.8e8712eb.js";const m='{"title":"Introduction","description":"","frontmatter":{"title":"Introduction"},"headers":[{"level":2,"title":"Should you use Profectus?","slug":"should-you-use-profectus"},{"level":3,"title":"Alternative Engines","slug":"alternative-engines"},{"level":2,"title":"Design Philosophies","slug":"design-philosophies"}],"relativePath":"guide/index.md"}',a={},r=n('<h1 id="introduction" tabindex="-1">Introduction <a class="header-anchor" href="#introduction" aria-hidden="true">#</a></h1><p>Profectus is a web-based game engine. You can write your content using many built in features, write your own features, and build up complex gameplay quickly and easily.</p><p>The purpose of creating profectus was to create an easy to use engine that does not create a ceiling for a programmer&#39;s personal growth. This engine will grow in complexity with you, empowering you to create increasingly complex designs and mechanics.</p><h2 id="should-you-use-profectus" tabindex="-1">Should you use Profectus? <a class="header-anchor" href="#should-you-use-profectus" aria-hidden="true">#</a></h2><p>While this engine is intended to make game development (and web app development) easier, it still requires you to be comfortable with programming in general and javascript in particular. Fortunately, that is a solvable problem.</p><p>If you&#39;ve never used Javascript before, <a href="https://www.learn-js.org/" target="_blank" rel="noopener noreferrer">learn-js.org</a> is a good resource for learning the important concepts. If you&#39;d like a more thorough lesson on all the ins and outs of web development, <a href="https://javascript.info" target="_blank" rel="noopener noreferrer">javascript.info</a> and <a href="https://developer.mozilla.org/en-US/docs/Learn/JavaScript" target="_blank" rel="noopener noreferrer">MDN&#39;s tutorials</a> should have you covered. MDN is also a great resource to use as a reference - for example, if you want to know more about something and you google it, there&#39;ll typically be a MDN link that&#39;ll explain it thoroughly.</p><p>Beyond the basics, Profectus uses a modern web development pipeline, using tools like node, typescript, and JSX. While most of it should be relatively easy to pick up through context, if this becomes too complicated you may be interested in <a href="https://github.com/Acamaeda/The-Modding-Tree/" target="_blank" rel="noopener noreferrer">The Modding Tree</a>, a predecessor of Profectus that uses plain old javascript.</p><h3 id="alternative-engines" tabindex="-1">Alternative Engines <a class="header-anchor" href="#alternative-engines" aria-hidden="true">#</a></h3><p>There are many popular game engines out there, such as <a href="https://www.yoyogames.com/" target="_blank" rel="noopener noreferrer">GameMaker Studio 2</a>, <a href="https://unity.com" target="_blank" rel="noopener noreferrer">Unity3D</a>, <a href="https://www.unrealengine.com/" target="_blank" rel="noopener noreferrer">Unreal Engine 4</a>, and <a href="https://godotengine.org" target="_blank" rel="noopener noreferrer">Godot</a>, that are all general purpose and also more useful if you&#39;re planning on going into a career in game development. These are all more mature and robust game engines compared to Profectus, and are used by actual game development studios.</p><p>Profectus, on the other hand, is a very opinionated engine that is better at specific types of projects. Where the above engines will require you to design and create your own interfaces, menus, save management systems, etc. Profectus will include those out of the box. Profectus will also output games that run natively in the browser, and will typically be easier for players to play than traditional engines.</p><p>If you are not interested in programming but still want to get into game development, the above engines also all support &quot;visual programming&quot;, which may be more amenable to you. Each engine will have varying levels of support, and of course with varying complexities, but ultimately any of these will help you learn the concepts of programming and game development, and all of them also offer traditional programming for when you think you&#39;re ready.</p><h2 id="design-philosophies" tabindex="-1">Design Philosophies <a class="header-anchor" href="#design-philosophies" aria-hidden="true">#</a></h2><p>While absolute purity is impossible, design decisions have been and will continue to be made using these principles in mind.</p><ul><li>An engine should be intuitive, and code readable without context</li><li>An engine should not constrain a creator</li><li>An engine should be consistent</li><li>An engine should be extensible, and those extensions sharable</li><li>An engine should be efficient</li><li>An engine should report issues early and thoroughly</li><li>Passing by reference is one honking great idea -- <a href="https://www.python.org/dev/peps/pep-0020/" target="_blank" rel="noopener noreferrer">let&#39;s do more of that</a>! <ul><li><a href="https://dev.to/ycmjason/thought-on-vue-3-composition-api-reactive-considered-harmful-j8c" target="_blank" rel="noopener noreferrer">Refs are better than reactive objects</a></li></ul></li></ul>',14),i=[r];function s(l,u,h,p,d,c){return t(),o("div",null,i)}var f=e(a,[["render",s]]);export{m as __pageData,f as default};