Skip to content

Dungeons-of-Kathallion/Bane-Of-Wargs

Repository files navigation

Bane Of Wargs (BETA)

████████████████████████████████████████████████████████████████████▀███████
█▄─▄─▀██▀▄─██▄─▀█▄─▄█▄─▄▄─███─▄▄─█▄─▄▄─███▄─█▀▀▀█─▄██▀▄─██▄─▄▄▀█─▄▄▄▄█─▄▄▄▄█
██─▄─▀██─▀─███─█▄▀─███─▄█▀███─██─██─▄██████─█─█─█─███─▀─███─▄─▄█─██▄─█▄▄▄▄─█
▀▄▄▄▄▀▀▄▄▀▄▄▀▄▄▄▀▀▄▄▀▄▄▄▄▄▀▀▀▄▄▄▄▀▄▄▄▀▀▀▀▀▀▄▄▄▀▄▄▄▀▀▄▄▀▄▄▀▄▄▀▄▄▀▄▄▄▄▄▀▄▄▄▄▄▀

╭────────────────────────────────────────────────────╮
│ 0> Play Game                                       │
│ 1> Manage Saves                                    │
│ 2> Preferences                                     │
│ 3> Gameplay Guide                                  │
│ 4> Check Logs                                      │
│ 5> Credits                                         │
│ 6> Quit                                            │
╰────────────────────────────────────────────────────╯
$ _

License: GPL v3 Python Version CD Validate-YAML Spell Checks

Bane Of Wargs is a python text-game engine with pre-built plots and the ability to create custom plugins/mods that completely change the game content. The game is very customizable and you will find many in-game features: equipment upgrading, items orders, mounts training over time, xp gaining, hp gaining, etc. This provides a very customizable and enjoyable python terminal-text based RPG.

You will have to fight monsters and bossses to get keys to unlock new areas on the map. The map is divided into points, determined by x and y coordinates, allowing maps up to 128x128 wide (so up to 16,384 places to explore), and more will be available as the engine progresses.

See the Gameplay Guide wiki page or check or the Creating Mod wiki page if you're interested in modding the game.


Here's the vanilla starting dialog plot:

“ You're a lumberjack who lives in a small village in the Forlindon Woods, a quiet a calm place to live. You've always wondered what's after this quiet forest; because your little village is a small town that lives apart from the other great cities in the Stall Island, Kathallion Archipelago. You've heard some stories and tales about the rest of the world. Only some words come to your mind when you hear "the world": dragons, gold, elves, dwarfs, great mountains, adventure...

A day like others, you get a message in your mailbox: a dwarf king from the Goro Mountains Peaks has heard from the mayor of the village, who keeps contact with him because they provide the village in stone, that you have great woodcraft skills. This dwarf king requests you to come to his castle in the mountains of the Goro Peaks to participate to a great project...

You decide to accept the deal, because of the great promiced remuneration. You'll travel into many places like the Californ Woods, the Stall Fields, and many other great places. ”

Check some gameplay shots:

Screenshot from 2024-03-15 19-10-58

Screenshot from 2024-03-15 19-10-44

Screenshot from 2024-03-15 19-10-21

Screenshot from 2024-03-15 19-10-10

Screenshot from 2024-03-15 19-10-06

Screenshot from 2024-03-15 19-09-58

Screenshot from 2024-03-15 19-09-43

Screenshot from 2024-03-15 19-09-08

Screenshot from 2024-03-15 19-08-44

Screenshot from 2024-03-15 19-08-29

Screenshot from 2024-03-15 19-08-17

Screenshot from 2024-03-15 19-07-40

Screenshot from 2024-03-15 19-06-56

Screenshot from 2024-03-15 19-06-33

Screenshot from 2024-03-15 19-06-23

Screenshot from 2024-03-15 19-06-08

Screenshot from 2024-03-15 19-05-39

Screenshot from 2024-03-15 19-05-23

Screenshot from 2024-03-15 19-05-02

Screenshot from 2024-03-15 19-04-47

Screenshot from 2024-03-15 19-04-18

Screenshot from 2024-03-15 19-04-06

Screenshot from 2024-03-15 19-03-45

Screenshot from 2024-03-15 19-03-14

Screenshot from 2024-03-15 19-02-57

Screenshot from 2024-03-15 19-02-14

Screenshot from 2024-03-15 19-01-29

Screenshot from 2024-03-15 19-01-12

Installing The Game

pip install -r requirements.txt
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. Note that you can also download the pre-built game executable from the Continuous Build.

Building From Source

We recommend to build the game using the PyInstaller program, but you could use any if you'd like, but we only support PyInstaller.There's a full documentation about building the game using PyInstaller at docs/BUILDING.md.

System Requirements

Bane Of Wargs is a minimal game (requires a small number of dependencies), but you will have to install/update some python modules. All required modules are in the requirements.txt file.

Module PyPi Link Version
Fade https://pypi.org/project/fade/ latest-version
GitPython https://pypi.org/project/GitPython/ latest-version
Colorama https://pypi.org/project/colorama/ latest-version
PyYaml https://pypi.org/project/PyYAML/ latest-version
Yamale https://pypi.org/project/yamale/ latest-version
Fsspec https://filesystem-spec.readthedocs.io/en/latest/index.html latest-version
AppDirs https://pypi.org/project/appdirs/ latest-version
Requests https://pypi.org/project/requests/ latest-version
Rich https://pypi.org/project/rich/ latest-version

If you have already run the pip install -r requirements.txt command, then you won't have to install these modules as they were installed for you.

Contributing

As a free and open source game, the source code is accessible to reading and modifying. You can contribute to the game by creating a github issue from here to request a new feature or report a bug. You can propose your own changes by creating a new pull request. Those who wish to contribute are recommended to checkout the wiki and the CONTRIBUTING guidelines.

Development Progress

The planned game engine is currently in progress, and for the most of it done. The vanilla gameplay is not ready at all by you could always create your own mod!. If you're interested by the game progress and development, check the wiki page about the Goals of the game.

Licensing

Bane Of Wargs is a free, open source game. The source code and every file you will find on this repository is available under the GPL v3 license. All its work and artwork is all copyrighted and credited. Feel free to fork, or copy the game source to make your own version of the engine.