If you'd like, you can also choose to use replit or glitch, which has several pros and cons, but one of the pros is not needing to setup any tool on your own computer.
If you are using git, you should create a new project from the Profectus repository via the "Use this template" button. You can then copy the link for the repository to clone it locally.
INFO
Since the repository is a template repository, you can easily create new repos from it, allowing you to have multiple project easily. However, it does make updating an existing project to a newer version of Profectus more difficult.
It's recommended to create a new git branch for development, so you can push your changes without it affecting the live build. This allows you to continue working with smaller commits, and only release new versions when you're actually ready to. The github workflow will automatically rebuild the page whenever you push to the main branch.
The next step is to install Profectus' dependencies. This is as simple as running npm install.
You can now run npm serve to start a local server that will host your project so you can work on it. As you change files the site will automatically reload them.
At least to start, everything you'll be messing with is inside the /src/data directory. This contains everything specific to the project itself, from its metadata, the content itself, utility functions, a changelog, and any custom UI themes.
The first file you'll want to edit is /src/data/modInfo.json. This contains information on the name of the project, its creator, a discord server to link to, and some other general information about the project.
If you're using git, deploying is as easy as pushing your changes to the main branch. In a couple minutes the site will be updated fully automatically. If you'd like to see progress on it, or look at any errors that happened, you can do so from the actions tab on your repository.
Before github knows to actually host the generated site, you'll have to enable github pages in the repo settings. This just means selecting the branch to use - gh-pages. You will only need to perform this step once. This will automatically start another github action to deploy the website.
',26),c=[s];function l(h,p,d,u,g,m){return o(),t("div",null,c)}var b=e(i,[["render",l]]);export{y as __pageData,b as default};
diff --git a/assets/guide_getting-started.md.3720ce0b.lean.js b/assets/guide_getting-started.md.3720ce0b.lean.js
new file mode 100644
index 00000000..9b0378f6
--- /dev/null
+++ b/assets/guide_getting-started.md.3720ce0b.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o,a as r}from"./app.82a3cbba.js";var a="/assets/actionsbutton.f1ba9d8e.png",n="/assets/gh-pages.a24cefcf.png";const y='{"title":"Getting Started","description":"","frontmatter":{},"headers":[{"level":2,"title":"Setting up environment","slug":"setting-up-environment"},{"level":2,"title":"Project structure","slug":"project-structure"},{"level":2,"title":"Deploying","slug":"deploying"}],"relativePath":"guide/getting-started.md"}',i={},s=r("",26),c=[s];function l(h,p,d,u,g,m){return o(),t("div",null,c)}var b=e(i,[["render",l]]);export{y as __pageData,b as default};
diff --git a/assets/guide_getting-started.md.8d9ff847.js b/assets/guide_getting-started.md.8d9ff847.js
deleted file mode 100644
index b0ab8e2d..00000000
--- a/assets/guide_getting-started.md.8d9ff847.js
+++ /dev/null
@@ -1 +0,0 @@
-import{_ as e,c as t,o,a as r}from"./app.82a3cbba.js";var a="/assets/actionsbutton.f1ba9d8e.png",n="/assets/gh-pages.a24cefcf.png";const y='{"title":"Getting Started","description":"","frontmatter":{},"headers":[{"level":2,"title":"Setting up environment","slug":"setting-up-environment"},{"level":3,"title":"Tools","slug":"tools"},{"level":3,"title":"Creating your project","slug":"creating-your-project"},{"level":3,"title":"Running your project","slug":"running-your-project"},{"level":2,"title":"Project structure","slug":"project-structure"},{"level":3,"title":"Setting up project metadata","slug":"setting-up-project-metadata"},{"level":3,"title":"Creating your project","slug":"creating-your-project-1"},{"level":2,"title":"Deploying","slug":"deploying"}],"relativePath":"guide/getting-started.md"}',i={},s=r('
If you'd like, you can also choose to use replit or glitch, which has several pros and cons, but one of the pros is not needing to setup any tool on your own computer.
If you are using git, you should create a new project from the Profectus repository. You can then copy the link for the repository to clone it locally.
INFO
Since the repository is a template repository, you can easily create new repos from it, allowing you to have multiple project easily. However, it does make updating an existing project to a newer version of Profectus more difficult.
It's recommended to create a new git branch for development, so you can push your changes without it affecting the live build. This allows you to continue working with smaller commits, and only release new versions when you're actually ready to. The github workflow will automatically rebuild the page whenever you push to the main branch.
The next step is to install Profectus' dependencies. This is as simple as running npm install.
You can now run npm serve to start a local server that will host your project so you can work on it. As you change files the site will automatically reload them.
At least to start, everything you'll be messing with is inside the /src/data directory. This contains everything specific to the project itself, from its metadata, the content itself, utility functions, a changelog, and any custom UI themes.
The first file you'll want to edit is /src/data/modInfo.json. This contains information on the name of the project, its creator, a discord server to link to, and some other general information about the project.
If you're using git, deploying is as easy as pushing your changes to the main branch. In a couple minutes the site will be updated fully automatically. If you'd like to see progress on it, or look at any errors that happened, you can do so from the actions tab on your repository.
Before github knows to actually host the generated site, you'll have to enable github pages in the repo settings. This just means selecting the branch to use - gh-pages. You will only need to perform this step once. This will automatically start another github action to deploy the website.
',26),c=[s];function l(h,p,u,d,g,m){return o(),t("div",null,c)}var b=e(i,[["render",l]]);export{y as __pageData,b as default};
diff --git a/assets/guide_getting-started.md.8d9ff847.lean.js b/assets/guide_getting-started.md.8d9ff847.lean.js
deleted file mode 100644
index b1f004a6..00000000
--- a/assets/guide_getting-started.md.8d9ff847.lean.js
+++ /dev/null
@@ -1 +0,0 @@
-import{_ as e,c as t,o,a as r}from"./app.82a3cbba.js";var a="/assets/actionsbutton.f1ba9d8e.png",n="/assets/gh-pages.a24cefcf.png";const y='{"title":"Getting Started","description":"","frontmatter":{},"headers":[{"level":2,"title":"Setting up environment","slug":"setting-up-environment"},{"level":3,"title":"Tools","slug":"tools"},{"level":3,"title":"Creating your project","slug":"creating-your-project"},{"level":3,"title":"Running your project","slug":"running-your-project"},{"level":2,"title":"Project structure","slug":"project-structure"},{"level":3,"title":"Setting up project metadata","slug":"setting-up-project-metadata"},{"level":3,"title":"Creating your project","slug":"creating-your-project-1"},{"level":2,"title":"Deploying","slug":"deploying"}],"relativePath":"guide/getting-started.md"}',i={},s=r("",26),c=[s];function l(h,p,u,d,g,m){return o(),t("div",null,c)}var b=e(i,[["render",l]]);export{y as __pageData,b as default};
diff --git a/assets/guide_index.md.93d63ef2.js b/assets/guide_index.md.93d63ef2.js
deleted file mode 100644
index 5f656d86..00000000
--- a/assets/guide_index.md.93d63ef2.js
+++ /dev/null
@@ -1 +0,0 @@
-import{_ as t,c as n,o,b as e,d as a}from"./app.82a3cbba.js";const y='{"title":"Introduction","description":"","frontmatter":{"title":"Introduction"},"headers":[],"relativePath":"guide/index.md"}',i={},r=e("h1",{id:"introduction",tabindex:"-1"},[a("Introduction "),e("a",{class:"header-anchor",href:"#introduction","aria-hidden":"true"},"#")],-1),s=e("p",null,"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.",-1),c=e("p",null,"The purpose of creating profectus was to create an easy to use engine that does not create a ceiling for a programmer's personal growth. This engine will grow in complexity with you, empowering you to create increasingly complex designs and mechanics.",-1),d=[r,s,c];function u(l,p,_,h,g,m){return o(),n("div",null,d)}var w=t(i,[["render",u]]);export{y as __pageData,w as default};
diff --git a/assets/guide_index.md.93d63ef2.lean.js b/assets/guide_index.md.93d63ef2.lean.js
deleted file mode 100644
index 5f656d86..00000000
--- a/assets/guide_index.md.93d63ef2.lean.js
+++ /dev/null
@@ -1 +0,0 @@
-import{_ as t,c as n,o,b as e,d as a}from"./app.82a3cbba.js";const y='{"title":"Introduction","description":"","frontmatter":{"title":"Introduction"},"headers":[],"relativePath":"guide/index.md"}',i={},r=e("h1",{id:"introduction",tabindex:"-1"},[a("Introduction "),e("a",{class:"header-anchor",href:"#introduction","aria-hidden":"true"},"#")],-1),s=e("p",null,"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.",-1),c=e("p",null,"The purpose of creating profectus was to create an easy to use engine that does not create a ceiling for a programmer's personal growth. This engine will grow in complexity with you, empowering you to create increasingly complex designs and mechanics.",-1),d=[r,s,c];function u(l,p,_,h,g,m){return o(),n("div",null,d)}var w=t(i,[["render",u]]);export{y as __pageData,w as default};
diff --git a/assets/guide_index.md.eb7e742c.js b/assets/guide_index.md.eb7e742c.js
new file mode 100644
index 00000000..9607842f
--- /dev/null
+++ b/assets/guide_index.md.eb7e742c.js
@@ -0,0 +1 @@
+import{_ as o,c as i,o as n,b as e,d as t}from"./app.82a3cbba.js";const y='{"title":"Introduction","description":"","frontmatter":{"title":"Introduction"},"headers":[{"level":2,"title":"Design Philosophies","slug":"design-philosophies"}],"relativePath":"guide/index.md"}',s={},a=e("h1",{id:"introduction",tabindex:"-1"},[t("Introduction "),e("a",{class:"header-anchor",href:"#introduction","aria-hidden":"true"},"#")],-1),r=e("p",null,"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.",-1),c=e("p",null,"The purpose of creating profectus was to create an easy to use engine that does not create a ceiling for a programmer's personal growth. This engine will grow in complexity with you, empowering you to create increasingly complex designs and mechanics.",-1),d=e("h2",{id:"design-philosophies",tabindex:"-1"},[t("Design Philosophies "),e("a",{class:"header-anchor",href:"#design-philosophies","aria-hidden":"true"},"#")],-1),l=[a,r,c,d];function h(u,p,g,_,m,f){return n(),i("div",null,l)}var w=o(s,[["render",h]]);export{y as __pageData,w as default};
diff --git a/assets/guide_index.md.eb7e742c.lean.js b/assets/guide_index.md.eb7e742c.lean.js
new file mode 100644
index 00000000..9607842f
--- /dev/null
+++ b/assets/guide_index.md.eb7e742c.lean.js
@@ -0,0 +1 @@
+import{_ as o,c as i,o as n,b as e,d as t}from"./app.82a3cbba.js";const y='{"title":"Introduction","description":"","frontmatter":{"title":"Introduction"},"headers":[{"level":2,"title":"Design Philosophies","slug":"design-philosophies"}],"relativePath":"guide/index.md"}',s={},a=e("h1",{id:"introduction",tabindex:"-1"},[t("Introduction "),e("a",{class:"header-anchor",href:"#introduction","aria-hidden":"true"},"#")],-1),r=e("p",null,"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.",-1),c=e("p",null,"The purpose of creating profectus was to create an easy to use engine that does not create a ceiling for a programmer's personal growth. This engine will grow in complexity with you, empowering you to create increasingly complex designs and mechanics.",-1),d=e("h2",{id:"design-philosophies",tabindex:"-1"},[t("Design Philosophies "),e("a",{class:"header-anchor",href:"#design-philosophies","aria-hidden":"true"},"#")],-1),l=[a,r,c,d];function h(u,p,g,_,m,f){return n(),i("div",null,l)}var w=o(s,[["render",h]]);export{y as __pageData,w as default};
diff --git a/assets/index.md.029d80a9.js b/assets/index.md.029d80a9.js
deleted file mode 100644
index f7d7f901..00000000
--- a/assets/index.md.029d80a9.js
+++ /dev/null
@@ -1 +0,0 @@
-import{_ as e,c as t,o,b as a}from"./app.82a3cbba.js";const _='{"title":"Home","description":"","frontmatter":{"home":true,"title":"Home","heroText":"Profectus","tagline":"A game engine that grows with you","actionText":"Get Started","actionLink":"/guide/getting-started","features":[{"title":"Easy to Use","details":"Everything is written to be as intuitive to use as possible"},{"title":"Well integrated","details":"Seamlessly deploy your project, get type hints in your IDE, etc."},{"title":"Incremental","details":"Designed to actively encourage you to become better at programming"}],"footer":"Copyright \xA9 2022 thepaperpilot"},"headers":[],"relativePath":"index.md"}',i={},r=a("p",null,"Profectus is a super cool engine for making browser based games!",-1),s=[r];function n(c,l,d,p,g,u){return o(),t("div",null,s)}var h=e(i,[["render",n]]);export{_ as __pageData,h as default};
diff --git a/assets/index.md.029d80a9.lean.js b/assets/index.md.029d80a9.lean.js
deleted file mode 100644
index f7d7f901..00000000
--- a/assets/index.md.029d80a9.lean.js
+++ /dev/null
@@ -1 +0,0 @@
-import{_ as e,c as t,o,b as a}from"./app.82a3cbba.js";const _='{"title":"Home","description":"","frontmatter":{"home":true,"title":"Home","heroText":"Profectus","tagline":"A game engine that grows with you","actionText":"Get Started","actionLink":"/guide/getting-started","features":[{"title":"Easy to Use","details":"Everything is written to be as intuitive to use as possible"},{"title":"Well integrated","details":"Seamlessly deploy your project, get type hints in your IDE, etc."},{"title":"Incremental","details":"Designed to actively encourage you to become better at programming"}],"footer":"Copyright \xA9 2022 thepaperpilot"},"headers":[],"relativePath":"index.md"}',i={},r=a("p",null,"Profectus is a super cool engine for making browser based games!",-1),s=[r];function n(c,l,d,p,g,u){return o(),t("div",null,s)}var h=e(i,[["render",n]]);export{_ as __pageData,h as default};
diff --git a/assets/index.md.197c9aad.js b/assets/index.md.197c9aad.js
new file mode 100644
index 00000000..9a51ef51
--- /dev/null
+++ b/assets/index.md.197c9aad.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o}from"./app.82a3cbba.js";const g='{"title":"Home","description":"","frontmatter":{"home":true,"title":"Home","heroText":"Profectus","tagline":"A game engine that grows with you","actionText":"Get Started","actionLink":"/guide/getting-started","features":[{"title":"Easy to Use","details":"Everything is written to be as intuitive to use as possible"},{"title":"Well integrated","details":"Seamlessly deploy your project, get type hints in your IDE, etc."},{"title":"Incremental","details":"Designed to actively encourage you to become better at programming"}],"footer":"Copyright \xA9 2022 thepaperpilot"},"headers":[],"relativePath":"index.md"}',i={};function a(r,n,s,c,l,d){return o(),t("div")}var m=e(i,[["render",a]]);export{g as __pageData,m as default};
diff --git a/assets/index.md.197c9aad.lean.js b/assets/index.md.197c9aad.lean.js
new file mode 100644
index 00000000..9a51ef51
--- /dev/null
+++ b/assets/index.md.197c9aad.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o}from"./app.82a3cbba.js";const g='{"title":"Home","description":"","frontmatter":{"home":true,"title":"Home","heroText":"Profectus","tagline":"A game engine that grows with you","actionText":"Get Started","actionLink":"/guide/getting-started","features":[{"title":"Easy to Use","details":"Everything is written to be as intuitive to use as possible"},{"title":"Well integrated","details":"Seamlessly deploy your project, get type hints in your IDE, etc."},{"title":"Incremental","details":"Designed to actively encourage you to become better at programming"}],"footer":"Copyright \xA9 2022 thepaperpilot"},"headers":[],"relativePath":"index.md"}',i={};function a(r,n,s,c,l,d){return o(),t("div")}var m=e(i,[["render",a]]);export{g as __pageData,m as default};
diff --git a/guide/getting-started.html b/guide/getting-started.html
index acec62d3..a68e1157 100644
--- a/guide/getting-started.html
+++ b/guide/getting-started.html
@@ -7,15 +7,15 @@
-
+
-
If you'd like, you can also choose to use replit or glitch, which has several pros and cons, but one of the pros is not needing to setup any tool on your own computer.
If you are using git, you should create a new project from the Profectus repository. You can then copy the link for the repository to clone it locally.
INFO
Since the repository is a template repository, you can easily create new repos from it, allowing you to have multiple project easily. However, it does make updating an existing project to a newer version of Profectus more difficult.
It's recommended to create a new git branch for development, so you can push your changes without it affecting the live build. This allows you to continue working with smaller commits, and only release new versions when you're actually ready to. The github workflow will automatically rebuild the page whenever you push to the main branch.
The next step is to install Profectus' dependencies. This is as simple as running npm install.
You can now run npm serve to start a local server that will host your project so you can work on it. As you change files the site will automatically reload them.
At least to start, everything you'll be messing with is inside the /src/data directory. This contains everything specific to the project itself, from its metadata, the content itself, utility functions, a changelog, and any custom UI themes.
The first file you'll want to edit is /src/data/modInfo.json. This contains information on the name of the project, its creator, a discord server to link to, and some other general information about the project.
If you're using git, deploying is as easy as pushing your changes to the main branch. In a couple minutes the site will be updated fully automatically. If you'd like to see progress on it, or look at any errors that happened, you can do so from the actions tab on your repository.
Before github knows to actually host the generated site, you'll have to enable github pages in the repo settings. This just means selecting the branch to use - gh-pages. You will only need to perform this step once. This will automatically start another github action to deploy the website.
If you'd like, you can also choose to use replit or glitch, which has several pros and cons, but one of the pros is not needing to setup any tool on your own computer.
If you are using git, you should create a new project from the Profectus repository via the "Use this template" button. You can then copy the link for the repository to clone it locally.
INFO
Since the repository is a template repository, you can easily create new repos from it, allowing you to have multiple project easily. However, it does make updating an existing project to a newer version of Profectus more difficult.
It's recommended to create a new git branch for development, so you can push your changes without it affecting the live build. This allows you to continue working with smaller commits, and only release new versions when you're actually ready to. The github workflow will automatically rebuild the page whenever you push to the main branch.
The next step is to install Profectus' dependencies. This is as simple as running npm install.
You can now run npm serve to start a local server that will host your project so you can work on it. As you change files the site will automatically reload them.
At least to start, everything you'll be messing with is inside the /src/data directory. This contains everything specific to the project itself, from its metadata, the content itself, utility functions, a changelog, and any custom UI themes.
The first file you'll want to edit is /src/data/modInfo.json. This contains information on the name of the project, its creator, a discord server to link to, and some other general information about the project.
If you're using git, deploying is as easy as pushing your changes to the main branch. In a couple minutes the site will be updated fully automatically. If you'd like to see progress on it, or look at any errors that happened, you can do so from the actions tab on your repository.
Before github knows to actually host the generated site, you'll have to enable github pages in the repo settings. This just means selecting the branch to use - gh-pages. You will only need to perform this step once. This will automatically start another github action to deploy the website.
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.
The purpose of creating profectus was to create an easy to use engine that does not create a ceiling for a programmer's personal growth. This engine will grow in complexity with you, empowering you to create increasingly complex designs and mechanics.
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.
The purpose of creating profectus was to create an easy to use engine that does not create a ceiling for a programmer's personal growth. This engine will grow in complexity with you, empowering you to create increasingly complex designs and mechanics.
