added an addon installation page - #45
Open
zion8992 wants to merge 2 commits into
Open
Conversation
Argmaster
reviewed
Jul 26, 2026
| --- | ||
|
|
||
| ## Biomes | ||
| Every biome is defined by a `zig.zon` file that contains all the data the world generator needs to generate it. |
Contributor
There was a problem hiding this comment.
Suggested change
| Every biome is defined by a `zig.zon` file that contains all the data the world generator needs to generate it. | |
| Every biome is defined by a `<biome_name>.zig.zon` file that contains all the data the world generator needs to generate it. |
Imo we should add a full name template to avoid confusion. Also adding sentence with examples could be a good idea.
| --- | ||
|
|
||
| ## Blocks | ||
| Every block has a `zig.zon` file containing all the properties of each block. |
Contributor
There was a problem hiding this comment.
Suggested change
| Every block has a `zig.zon` file containing all the properties of each block. | |
| Every block has a `<block_name>.zig.zon` file containing all the properties of each block. |
Same as biomes.
|
|
||
| ## 2. Install the addon | ||
|
|
||
| Once you have your addon file, pick a Cubyz world to install it to, then open that Cubyz World's directory. You can find a folder button near the world name on the world selection screen in Cubyz that will open the world directory for you. |
Contributor
There was a problem hiding this comment.
Definitely needs a screenshot.
|
|
||
| Once you have your addon file, pick a Cubyz world to install it to, then open that Cubyz World's directory. You can find a folder button near the world name on the world selection screen in Cubyz that will open the world directory for you. | ||
|
|
||
| Once in your worlds directory, enter the `assets` folder and place your downloaded addon file into there. After that **extract** into a folder. If the folder name contains any character aside from letters 'a' to 'z', numbers '0' to '9' and '_', your game will crash. |
Contributor
There was a problem hiding this comment.
Suggested change
| Once in your worlds directory, enter the `assets` folder and place your downloaded addon file into there. After that **extract** into a folder. If the folder name contains any character aside from letters 'a' to 'z', numbers '0' to '9' and '_', your game will crash. | |
| Once in your worlds directory, enter the `assets` folder and place your downloaded addon file into there. After that **extract** into a folder. |
You repeated that part. It's already in debugging section.
| zensical==0.0.50 | ||
| jinja2>=3.1,<3.2 | ||
| pydantic>=2.13,<2.14 | ||
| pyparsing>=3.3.2 |
Contributor
There was a problem hiding this comment.
Suggested change
| pyparsing>=3.3.2 | |
| pyparsing>=3.3.2,<3.4 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes in this PR
Added an 'How to install an Addon' page (under the
developmentfolder)I also added 'pyparsing' to the pip requirements since Zensical was crashing without it.
(I think it is @Argmaster who added it.)
I also fixed a typo in the FAQ page and fixed some broken links
Added icons to ever single addon-related page in the
development/addonsfolder