Skip to content

VueJS 3 App made for making it easy to play my simple RPG System.

License

Notifications You must be signed in to change notification settings

dudematthew/boost-rpg-tools

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

BOOST-RPG-TOOLS

VueJS 3 App made for making it easy to play my simple RPG System. Currently only Polish language available.
Explore the website »
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

There are many RPG systems but I didn't find one that would withstand one-shot sessions that could be run without any preparation with non-abstract rules.

Example situations:

  • You meet your friends at vacations and you want to play RPG session but you didn't prepare anything
  • You want to introduce your friend to RPG Sessions but you don't want to scare them
  • You want to create something lightweight without any preparation and just go with the flow 😄

That's why I created BOOST RPG which is a simple system for this kind of situations. Also that's why I created BOOST RPG website (this project) to simple it down even more.

(back to top)

Built With

  • Vue
  • Bulma
  • Babel

(back to top)

Getting Started

Prerequisites

  • npm
npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/dudematthew/boost-rpg-tools.git
  2. Install NPM packages
    npm install
  3. Run server
    npm run serve

(back to top)

Usage

After build, the app will be available under dist

Build

npm run build

(back to top)

Roadmap

  • Add Home Page
  • BOOST Manual Page
  • User Panel
  • Game Master Panel
  • Multi-language Support
    • Polish
    • English

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

@dudematthew - [email protected]

Project Link: https://github.com/dudematthew/boost-rpg-tools

(back to top)

Acknowledgments

(back to top)

About

VueJS 3 App made for making it easy to play my simple RPG System.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published