Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEATURE: Custom Scripts Arguments Overhaul #101

Merged
merged 10 commits into from
May 1, 2024
20 changes: 19 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,25 @@ You'll use the following syntax:
* Please make your commit description the most compact, understandable and changes-related possible.

## Code Style
In order to make the code clean, optimized and themed, so that everyone can understand it better, we have a code style convention. Apart from keeping the code clean, optimized and themed, it keeps the code organized. We have different github actions that check the code style and syntax for you automatically when you create a pull request to the master branch of the Bane-Of-Wargs repo. Theses checks are required to be passing for the pull request to be merged by an inflow control or an admin. These checks verify the yaml data present in the `data/` directory (the actual yaml syntax and if the data is correct for it to work in the game engin), the spelling across most files, if the program compiles right, and finally, the actual python code style & syntax. The spelling should be american and not any other (british etc...)
In order to make the code clean, optimized and themed, so that everyone can understand it better, we have a code style convention. Apart from keeping the code clean, optimized and themed, it keeps the code organized. We have different github actions that check the code style and syntax for you automatically when you create a pull request to the master branch of the Bane-Of-Wargs repo. Theses checks are required to be passing for the pull request to be merged by an inflow control or an admin. These checks verify the yaml data present in the `data/` directory (the actual yaml syntax and if the data is correct for it to work in the game engin), the spelling across most files, if the program compiles right, and finally, the actual python code style & syntax. The spelling should be american and not any other (british etc...). If every game engine class gets added/removed/updated, make sure the game engine documentation ([`ENGINE_FUNCTIONS.md`](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs/blob/master/docs/ENGINE_FUNCTIONS.md)) gets updated.

Every python script or data file should have a copyright header:

```html
# python_script.py //only if it's a script
# Copyright (c) 2024 by <creator>
OcelotWalrus marked this conversation as resolved.
Show resolved Hide resolved
#
# Bane Of Wargs is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later version.
#
# Bane Of Wargs is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <https://www.gnu.org/licenses/>.
```

Here are the main code style conventions:

Expand Down
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,4 @@ This save file can be used to test these changes:
{{make sure to make a PR at the BOW-Progression repo (https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs-Progression) that update its data.}}
{{If this PR is adding any artwork (ASCII art), that is yours or not, update the `copyright` file.}}
{{If this PR is adding any new attribute to a data type, please update the corresponding `schemas/` and data checks (check_yaml.py class and yaml data test workflow script).}}
{{If this PR drastically changes or adds any functions to the game engine (or a new class), please update the game engine's documentation at docs/ENGINE_FUNCTIONS.md}}
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ python source/main.py
```

**It's highly recommended to use a clean terminal with the ability to zoom in or out. It is also recommended to use fullscreen with a monospace font for the best gameplay experience.**
**Also note that the color system is "truecolor", making that lower color systems terminal as Windows legacy terminal will go crazy. The new windows terminal does support "truecolor" color systems.**

_If you have any problems, check the full documentation on how to run the game from nothing at [`docs/PLAYING.MD`](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs/blob/master/docs/PLAYING.md)._
_Note that you can also download the pre-built game executable from the [Continuous Build](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs/releases/tag/9.9.9-continuous)._
Expand Down
20 changes: 19 additions & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,25 @@ You'll use the following syntax:
* Please make your commit description the most compact, understandable and changes-related possible.

## Code Style
In order to make the code clean, optimized and themed, so that everyone can understand it better, we have a code style convention. Apart from keeping the code clean, optimized and themed, it keeps the code organized. We have different github actions that check the code style and syntax for you automatically when you create a pull request to the master branch of the Bane-Of-Wargs repo. Theses checks are required to be passing for the pull request to be merged by an inflow control or an admin. These checks verify the yaml data present in the `data/` directory (the actual yaml syntax and if the data is correct for it to work in the game engin), the spelling across most files, if the program compiles right, and finally, the actual python code style & syntax. The spelling should be american and not any other (british etc...)
In order to make the code clean, optimized and themed, so that everyone can understand it better, we have a code style convention. Apart from keeping the code clean, optimized and themed, it keeps the code organized. We have different github actions that check the code style and syntax for you automatically when you create a pull request to the master branch of the Bane-Of-Wargs repo. Theses checks are required to be passing for the pull request to be merged by an inflow control or an admin. These checks verify the yaml data present in the `data/` directory (the actual yaml syntax and if the data is correct for it to work in the game engin), the spelling across most files, if the program compiles right, and finally, the actual python code style & syntax. The spelling should be american and not any other (british etc...). If every game engine class gets added/removed/updated, make sure the game engine documentation ([`ENGINE_FUNCTIONS.md`](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs/blob/master/docs/ENGINE_FUNCTIONS.md)) gets updated.

Every python script or data file should have a copyright header:

```html
# python_script.py //only if it's a script
# Copyright (c) 2024 by <creator>
OcelotWalrus marked this conversation as resolved.
Show resolved Hide resolved
#
# Bane Of Wargs is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later version.
#
# Bane Of Wargs is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <https://www.gnu.org/licenses/>.
```

Here are the main code style conventions:

Expand Down
Loading
Loading