Skip to content

Web-based role-playing game (RPG) engine demo, written in React.

License

Notifications You must be signed in to change notification settings

jacob-willden/the-cliche-rpg

Repository files navigation

The Cliché RPG

Source Code Location

This is a work in progress demo for a role-playing game (RPG) engine, with some clean, subpar humor mixed in. It's built using React, a JavaScript library. I'm aiming to make it as accessible as possible, whether with a keyboard, touch screen, mouse, trackpad, or any assistive technology that can be used to access the Web. All the same, my resources are limited and there's always something I might miss, so I'm completely open to any changes that will make this project more accessible (and this applies to any of my projects).

Note: The HTML utilizes the dialog element, which has only seen wide support in the past couple of years (see dialog element support on "Can I Use"), so testing will be needed in order to know how legacy software responds to the markup.

You can either play the game on a live site, or host it yourself using the following installation instructions.

Installation Instructions

  1. Install NPM, if you don't already have it installed
  2. Download the repository and extract the ZIP file
  3. Using a command line program (like the Windows Subsystem for Linux on Windows, or Terminal on Mac), change the directory into the extracted folder (e.g. cd ~/Downloads/the-cliche-rpg/)
  4. Run npm install to install dependencies
  5. Run npm run dev to start the server with the game on it

You can stop the server by either using a keyboard shortcut to cancel the run command (e.g. Control+C), or by quitting the command line program.

Todos

  • Fix audio issues
  • Add assistive technology testing results

Licensing

This project is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License (GNU GPL) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The project is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.

As additional permission under GNU GPL version 3 section 7, you may distribute non-source (e.g., minimized or compacted) forms of the code without the copy of the GNU GPL normally required by section 4, provided you include this license notice and a URL through which recipients can access the Corresponding Source.

You should have recieved a copy of the GNU General Public License along with this project. Otherwise, see: https://www.gnu.org/licenses/

Some parts of the code were derived from contributors on StackOverflow. The contributions from StackOverflow, being posted after 2011 and according to the site's documentation, are released under either Creative Commons Attribution Share-Alike 3.0 or 4.0. The later license is compatible with the GPL version 3 or later, on the condition that I specify Creative Commons as my proxy, and the former license is forwards-compatible, so it can be upgraded to verison 4.0 automatically. I specify Creative Commons as my proxy to make the contributions from StackOverflow compatible with future versions of the GPL. Every use of code from StackOverflow is specifically labeled as such. One portion of the code was derived from a snippet on Geoff Rich's Website. The Website's source code is available under the MIT License (more accurately known as the Expat License).

All in-game text, including dialogue, is authored by Jacob Willden and is released under the Creative Commons Zero License. The enemy sprites and background images were generated by Jacob Willden using Midjourney (paid subscription), and are released under the Creative Commons Zero License. The battle animations and item icons are from the Kenney Website, released under the Creative Commons Zero License. The sound effects are from the Yume Freebie Volume 1 Pack by plasterbrain, which is released under the Creative Commons Zero License.

About

Web-based role-playing game (RPG) engine demo, written in React.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published