Skip to content

Commit 8558573

Browse files
authored
Updated the description of README, also Usage
1 parent 9723cf7 commit 8558573

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,32 @@
3030
![image](assets/images/AAMobGif.gif)
3131

3232
## :wave: Description:
33-
Adventure Alchemist is an application with an aim to help make the process of generating dungeon scenarios for your tabletop RPGs, specifically DnD campaigns, easier and more accessible. This app utilizes a variety of algorithms and user preference to create, save and recall unique scenarios for the user. When generating a scenario the application takes into account various factors such as dungeon theme, size, and difficulty.
3433

35-
With Adventure Alchemist, both dungeon masters and players can swiftly conjure up imaginative and enthralling scenarios, injecting a fresh dose of excitement into their campaigns. This dynamic tool ensures gameplay remains engaging and invigorating.
34+
### 🔮 Adventure Alchemist: Dungeon Scenario Generator
3635

37-
Thanks so much for checking out Adventure Alchemist! The development journey of Adventure Alchemist has been a culmination of insights and lessons drawn from previous projects. Overcoming challenges, including nuances with localStorage and unique identifier issues, has been an integral part of refining the application. This project was also a commission and I received the green-light to keep this repository public for everyone to use. I devoted time into ensuring the code is modularized and easily modifiable. It's my hope that this application helps YOU out in anyway possible. Feel free to take a look through the files and fork it if you'd like, Happy Coding!
36+
Adventure Alchemist is a tool designed to simplify and enhance the process of generating captivating dungeon scenarios for tabletop RPGs, including DnD campaigns. Whether you're a seasoned Dungeon Master or a curious player, this application empowers you to effortlessly create, save, and recall unique scenarios based on your preferences.
37+
38+
If you're looking for ways to change things up on your tabletop games, try us out!
39+
40+
### 🚀 Features:
41+
42+
- Utilizes algorithms to create imaginative and engaging scenarios.
43+
- Considers factors such as dungeon theme, interior/exterior setting, size, monster types and difficulty for a more diverse experience.
44+
- Provides both dungeon masters and players with dynamic and invigorating scenarios.
45+
46+
### 🎯 Modern Approach:
47+
The development of Adventure Alchemist represents a fusion of insights from previous projects and modern JavaScript techniques. Leveraging arrow functions, the codebase is characterized by concise and readable syntax, enhancing both clarity and maintainability.
48+
49+
Adventure Alchemist is organized into ES6 JavaScript modules, ensuring clean separation of concerns and streamlined maintenance. Modules for DOM manipulation, localStorage management, scenario generation, and user interactions contribute to reusability and easy collaboration.
50+
51+
### 🌐 Accessible and Open:
52+
Adventure Alchemist originated as a commission and has been made public for the community to benefit from. The repository encourages exploration and collaboration, with the codebase thoughtfully organized and easily modifiable. Feel free to delve into the code, contribute, and customize it to your needs.
53+
54+
### 💭 Developer Notes:
55+
This application has been a very fun journey, it was immensely entertaining coming up with a variety of scenarios. Most fun was coming up with a framework on how Adventure Alchemist would work, a lot of that development came from back and forth conversations between with the client and I. There's a few more memorable moments I'm taking away from this app, such as troubleshooting and fixing issues with localStorage and adhering to modern techniques by using ES6 modules.
56+
57+
### 🙏 Thank You!
58+
For your interest in Adventure Alchemist. I hope this tool enriches your RPG experiences and adds a spark of creativity to your campaigns. Take a moment to explore the repository, and don't hesitate to share your feedback or contribute to the project. Happy coding!
3859

3960
## :book: User Story:
4061
**AS A Dungeon Master for a DnD Campaign**
@@ -74,14 +95,15 @@ To use Adventure Alchemist:
7495
Repeat steps 1-4 as desired
7596

7697
### Running Locally
98+
Because Adventure Alchemist is using ES6 Modules, the app WILL NOT function if you use `Open in Browser` (VSCode)
7799

78-
To run the Adventure Alchemist app locally, you can use a tool like `http-server`. If you haven't already installed it, you can install it globally using npm:
100+
So to run the app locally, you can use a tool like `http-server`. If you haven't already installed it, you can install it globally using npm:
79101

80102
```bash
81103
npm install -g http-server
82104
```
83105

84-
After installing, navigate to the root directory of your Adventure Alchemist project and run the following command:
106+
After installing, navigate to the root directory of Adventure Alchemist and run the following command:
85107

86108
```
87109
http-server -p 3000 --cors --module

0 commit comments

Comments
 (0)