/mushscape

An AI-powered text-based RPG that takes you on an exciting adventure through a magical universe full of challenges and unexpected twists

Primary LanguageVueGNU General Public License v3.0GPL-3.0

MushScape

Welcome to MushScape, an AI-powered text-based RPG that takes you on an exciting adventure through a magical universe full of challenges and unexpected twists. MushScape is an open source project and we welcome contributions from the community. This README provides you with all the information you need to get started with contributing to the game.

Getting Started

To get started with MushScape, you will need to follow these simple steps:

  1. Fork the repository to your own GitHub account.
  2. Clone the repository to your local machine using git clone https://github.com/yourusername/mushscape.git.
  3. Install the necessary dependencies by running npm install in the project root directory.
  4. Start the development server by running npm run dev.
  5. Open your browser and navigate to http://localhost:3000 to start playing the game and making changes to the code.

Recommended IDE Setup

We recommend using VSCode as your primary IDE for working with MushScape. You can use the following plugins to enhance your development experience:

Configuration

You can customize the configuration of MushScape using the Vite Configuration Reference. Refer to the Vite Configuration Reference for more information.

Scripts

The following scripts are available in MushScape:

  • dev: starts the development server using Vite
  • build: builds the project for production using Vite
  • preview: previews the built project using Vite

Contributing

We welcome contributions to MushScape from the open source community. Here are the steps to contribute:

  1. Fork the repository to your own GitHub account.
  2. Clone the repository to your local machine using git clone https://github.com/yourusername/mushscape.git.
  3. Create a new branch for your feature using git checkout -b my-feature.
  4. Make the necessary changes and commit them using git commit -am 'Added my new feature'.
  5. Push the changes to your fork using git push origin my-feature.
  6. Create a pull request on the main repository.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read the MushScape Open Source Repo Code of Conduct file for more information.

License

MushScape is licensed under the MIT License. Please refer to the LICENSE file for more information.