Welcome to Mycologist! This is a management video game where you play as a mycologist who owns a mushroom shop. Your goal is to find mushrooms in the forest, create various mushroom products, and sell them to customers.
TBD
- Three.js: A JavaScript library for creating 3D graphics in the browser.
- React Three Fiber: A React renderer for Three.js, making it easier to integrate Three.js into React applications.
- React: A JavaScript library for building user interfaces.
- HTML/CSS: Markup and styling for the user interface.
- JavaScript (ES6+): Programming language for game logic and interactivity.
To run the game locally, follow these steps:
-
Clone this repository to your local machine.
git clone https://github.com/electricganesha/mycologist.git
-
Navigate to the project directory.
cd mycologist
-
Install dependencies.
npm install
-
Start the development server.
npm install
-
Open your browser and navigate to http://localhost:3000 to play the game.
Contributions are welcome! If you'd like to contribute to Mycologist, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure that they work as expected.
- Commit your changes with descriptive commit messages.
- Push your changes to your fork.
- Submit a pull request to the main repository.
This project is licensed under the MIT License - see the LICENSE file for details. Acknowledgments
- Special thanks to the developers of Three.js, React Three Fiber, and React for providing the tools necessary to build this game.