incremental-social/The-Modding-Tree
incremental-social/The-Modding-Tree
Template
1
0
Fork 0
mirror of https://github.com/Acamaeda/The-Modding-Tree.git synced 2024-11-28 11:01:43 +00:00
Code Issues Releases Activity Actions

More documentation work

Browse source
This commit is contained in:
Acamaeda 2020-11-07 14:49:07 -05:00
parent 2a4612c8ec
commit 2c0822b43e
3 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/!general-info.md
View file

@ -44,5 +44,5 @@ While reading this documentation, the following key will be used when describing
- [Bars](bars.md): Display some information as a progress bar, gauge, or similar. They are highly customizable, and can be horizontal and vertical as well. - [Bars](bars.md): Display some information as a progress bar, gauge, or similar. They are highly customizable, and can be horizontal and vertical as well.
- [Subtabs and Microtabs](subtabs-and-microtabs.md): Create subtabs for your tabs, as well as "microtab" components that you can put inside the tabs. - [Subtabs and Microtabs](subtabs-and-microtabs.md): Create subtabs for your tabs, as well as "microtab" components that you can put inside the tabs.
You can even use them to embed a layer inside another layer! You can even use them to embed a layer inside another layer!
- [Achievements](milestones.md): How to create achievements for a layer (or for the whole game). - [Achievements](achievements.md): How to create achievements for a layer (or for the whole game).
- [Infoboxes](infoboxes.md): Boxes containing text that can be shown or hidden. - [Infoboxes](infoboxes.md): Boxes containing text that can be shown or hidden.

4
docs/getting-started.md
View file

@ -29,13 +29,13 @@ The benefits of using Github:
### Using your repository ### Using your repository
1. Click on "show in finder" to the right, and then open index.html. This will let you view and test your project! 1. Click on "show in explorer/finder" to the right, and then open the index.html file in the folder. The page should open up on your browser. This will let you view and test your project locally!
2. To edit your project, click "open in VSCode" in Github Desktop. 2. To edit your project, click "open in VSCode" in Github Desktop.
3. Open [mod.js](/js/mod.js) in VSCode, and look at the top part where it has a "modInfo" object. Fill in your mod's name to whatever you want, and change the id as well. (It can be any string value, and it's used to determine where the savefile is. Make it something that's probably unique, and don't change it again later or else it'll effectively wipe existing saves) 3. Open [mod.js](/js/mod.js) in VSCode, and look at the top part where it has a "modInfo" object. Fill in your mod's name to whatever you want, and change the id as well. (It can be any string value, and it's used to determine where the savefile is. Make it something that's probably unique, and don't change it again later or else it'll effectively wipe existing saves)
4. Save [mod.js](/js/mod.js), and then reload [index.html](/index.html) in your browser. The title on the tab, as well as on the info page, will now be updated! You can repeat this process every time you change the code to test it quickly and easily. 4. Save [mod.js](/js/mod.js), and then reload [index.html](/index.html) in your browser. The title on the tab, as well as on the info page, will now be updated! You can reload the page every time you change the code to test it quickly and easily.
5. Go back to Github Desktop. It's time to save your changes into the git system by making a "commit". This basically saves your work and creates a snapshot of what your code looks like at this moment, allowing you to look back at it later. 5. Go back to Github Desktop. It's time to save your changes into the git system by making a "commit". This basically saves your work and creates a snapshot of what your code looks like at this moment, allowing you to look back at it later.

6
docs/trees-and-tree-customization.md Normal file
View file

@ -0,0 +1,6 @@
# Trees and tree customization
If you want to have something beyond the standard tree on the left tab, you can do that in tree.js. You can change the layout
of the tree, including making non-layer nodes, change it into something other than a tree, or hide the left tab altogether.
This also introduces the "tree" component, which can be used in your layers as well.