2023-06-20 06:06:50 +02:00
|
|
|
# LibreWands
|
|
|
|
|
|
2023-07-16 00:31:41 +02:00
|
|
|
A collaboratively made ncurses RPG featuring magick and monsters.
|
2023-06-24 04:47:54 +02:00
|
|
|
|
|
|
|
|
## Project Goal
|
|
|
|
|
|
2023-07-16 00:31:41 +02:00
|
|
|
To collaboratively create a unique and high quality ncurses RPG that
|
|
|
|
|
takes cultural inspiration from the rennaissance and baroque periods in
|
|
|
|
|
Southern Europe. See the provided documentation for details.
|
2023-06-24 04:47:54 +02:00
|
|
|
|
2023-06-29 04:02:11 +02:00
|
|
|
## Limitations
|
|
|
|
|
|
|
|
|
|
### Runtime Requirements
|
2023-06-24 04:47:54 +02:00
|
|
|
|
|
|
|
|
* ncurses
|
|
|
|
|
|
2023-06-29 04:02:11 +02:00
|
|
|
### Build dependencies
|
2023-06-24 05:44:47 +02:00
|
|
|
|
2023-07-05 12:01:17 +02:00
|
|
|
* make
|
2023-06-25 01:49:42 +02:00
|
|
|
* gcc
|
2023-07-05 12:01:17 +02:00
|
|
|
* libncurses-dev
|
2023-07-14 02:19:53 +02:00
|
|
|
* imagemagick (optional, for documentation)
|
|
|
|
|
* librsvg2-bin (optional, for documentation)
|
2023-06-29 04:02:11 +02:00
|
|
|
* texlive-latex-base (optional, for documentation)
|
2023-06-24 05:44:47 +02:00
|
|
|
|
2023-06-28 03:52:05 +02:00
|
|
|
Documentation is installed to the /usr/doc/librewands/ directory.
|
2023-06-24 05:44:47 +02:00
|
|
|
|
2023-06-29 04:02:11 +02:00
|
|
|
### Supported Platforms
|
|
|
|
|
|
2023-07-16 00:31:41 +02:00
|
|
|
Currently, the only supported platform is GNU/Linux. Support for other
|
|
|
|
|
operating systems is planned.
|
2023-06-29 04:02:11 +02:00
|
|
|
|
2023-06-24 05:44:47 +02:00
|
|
|
## Contributing
|
|
|
|
|
|
2023-07-16 00:31:41 +02:00
|
|
|
There are a vast number of ways you can contribute to this project. Any
|
|
|
|
|
and all help is greatly appreciated.
|
2023-07-01 10:46:24 +02:00
|
|
|
|
|
|
|
|
* Help design the world using the map editor.
|
|
|
|
|
* Help design the world with pencil and paper.
|
|
|
|
|
* Help build and tune the game engine.
|
2023-07-16 00:31:41 +02:00
|
|
|
* Help write the game.
|
|
|
|
|
* Help hunt for bugs.
|
2023-07-01 10:46:24 +02:00
|
|
|
* Submit issue reports.
|
|
|
|
|
* Edit this README file.
|
|
|
|
|
* Edit our Makefile.
|
|
|
|
|
* Advocate for better standards compliance.
|
|
|
|
|
* Optimise our software.
|
|
|
|
|
* Help implement multiplayer.
|
|
|
|
|
* Help write our documentation.
|
|
|
|
|
* Develop software quality tests.
|
2023-07-16 00:31:41 +02:00
|
|
|
* Package this software for your favourite operating system.
|
|
|
|
|
* Spread the word about this project.
|
|
|
|
|
* Tell me how I can make contributing easier.
|
2023-07-01 10:46:24 +02:00
|
|
|
* Support my efforts at [LiberaPay.](https://liberapay.com/lofenyy/)
|
2023-07-01 06:40:19 +02:00
|
|
|
|
|
|
|
|
## Copyright Notice
|
|
|
|
|
|
2023-07-16 00:31:41 +02:00
|
|
|
This file is part of LibreWands.
|
2023-07-01 06:40:19 +02:00
|
|
|
|
2023-07-16 00:31:41 +02:00
|
|
|
LibreWands 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.
|
2023-07-01 06:40:19 +02:00
|
|
|
|
2023-07-16 00:31:41 +02:00
|
|
|
LibreWands 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.
|
2023-07-01 06:40:19 +02:00
|
|
|
|
2023-07-16 00:31:41 +02:00
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
|
along with LibreWands. If not, see https://www.gnu.org/licenses/.
|
