From b5f255c9a2e94bde8e7d369f4c81474a4264bb37 Mon Sep 17 00:00:00 2001 From: IntegratedQuantum Date: Sat, 26 Jul 2025 14:28:44 +0200 Subject: [PATCH] Move the guidelines to /docs --- .github/ISSUE_TEMPLATE/proposal.yml | 2 +- README.md | 8 ++++---- docs/CONTENT_SUGGESTIONS.md | 2 +- CONTRIBUTING.md => docs/CONTRIBUTING.md | 0 .../GAME_DESIGN_PRINCIPLES.md | 0 5 files changed, 6 insertions(+), 6 deletions(-) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (100%) rename GAME_DESIGN_PRINCIPLES.md => docs/GAME_DESIGN_PRINCIPLES.md (100%) diff --git a/.github/ISSUE_TEMPLATE/proposal.yml b/.github/ISSUE_TEMPLATE/proposal.yml index 0a4ea99a..7e43bd54 100644 --- a/.github/ISSUE_TEMPLATE/proposal.yml +++ b/.github/ISSUE_TEMPLATE/proposal.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - Please check if the feature aligns with the [Game Design Principles](https://github.com/PixelGuys/Cubyz/blob/master/GAME_DESIGN_PRINCIPLES.md) before making an issue. + Please check if the feature aligns with the [Game Design Principles](https://github.com/PixelGuys/Cubyz/blob/master/docs/GAME_DESIGN_PRINCIPLES.md) before making an issue. - type: textarea id: description attributes: diff --git a/README.md b/README.md index c939cffb..8e9dade0 100644 --- a/README.md +++ b/README.md @@ -50,10 +50,10 @@ sudo apt install libgl-dev libasound2-dev libx11-dev libxcursor-dev libxrandr-de # Contributing ### Code -Check out the [Contributing Guidelines](https://github.com/PixelGuys/Cubyz/blob/master/CONTRIBUTING.md) +Check out the [Contributing Guidelines](https://github.com/PixelGuys/Cubyz/blob/master/docs/CONTRIBUTING.md) ### Gameplay Additions -Check out the [Game Design Principles](https://github.com/PixelGuys/Cubyz/blob/master/GAME_DESIGN_PRINCIPLES.md) +Check out the [Game Design Principles](https://github.com/PixelGuys/Cubyz/blob/master/docs/GAME_DESIGN_PRINCIPLES.md) ### Textures If you want to add new textures, make sure they fit the style of the game. It's recommended that you have baseline skills in pixel art before attempting to make textures. A great collection of tutorials can be found [here](https://lospec.com/pixel-art-tutorials) @@ -65,9 +65,9 @@ If any of the following points are ignored, your texture will be rejected: 4. Reference other block textures to see how colours & contrast is used. Test your textures ingame alongside other blocks. 5. Blocks should tile smoothly. Avoid creating seams or repetitive patterns. 6. Use hue shifting conservatively. Take the material into account when choosing colours. -7. Items have full, coloured, 1-pixel outlines. It should be shaded so that the side in light (top left) is brighter, while the side in shadow (bottom right) is darker. +7. Items have full, coloured, 1-pixel outlines. It should be shaded so that the side in light (top left) is brighter, while the side in shadow (bottom right) is darker. 8. Items should have higher contrast than their block counterparts. -Your texture may be edited or replaced to ensure a consistent art style throughout the game. +Your texture may be edited or replaced to ensure a consistent art style throughout the game. For further information, ask [careeoki](https://github.com/careeoki) on [Discord](https://discord.gg/XtqCRRG). She has made a majority of the art for Cubyz. diff --git a/docs/CONTENT_SUGGESTIONS.md b/docs/CONTENT_SUGGESTIONS.md index 9be87012..b66f5392 100644 --- a/docs/CONTENT_SUGGESTIONS.md +++ b/docs/CONTENT_SUGGESTIONS.md @@ -3,6 +3,6 @@ It is easy to suggest something, but often it's much harder to implement and check if it fits the game. So, before making a suggestion here on github (you can of course freely discuss ideas on the community discord server), please do the following steps: -- check if it follows the [Game Design Principles](https://github.com/PixelGuys/Cubyz/blob/master/GAME_DESIGN_PRINCIPLES.md) +- check if it follows the [Game Design Principles](https://github.com/PixelGuys/Cubyz/blob/master/docs/GAME_DESIGN_PRINCIPLES.md) - make a reference implementation in the form of an addon, mod or fork of Cubyz (no content from other games) - create a pull request with the suggested changes or make an issue using the blank issue template, don't forget to add some screenshots \ No newline at end of file diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/GAME_DESIGN_PRINCIPLES.md b/docs/GAME_DESIGN_PRINCIPLES.md similarity index 100% rename from GAME_DESIGN_PRINCIPLES.md rename to docs/GAME_DESIGN_PRINCIPLES.md