Dimm City Portal VTT

Welcome to the repository of our open-source project, Dimm City Portal. This platform is designed for enthusiasts and players of tabletop roleplaying games (TTRPGs), allowing them to create, manage, and play their TTRPG experiences directly in their web browser without the need for complicated setup, or yet another subscription.

Check out the demo: https://demo.dimm.city

Features

• Web-Based: Play your favorite TTRPGs right in your web browser without the need for additional software or installations.
• Multiplayer Support: Invite friends to join your TTRPG session with multiplayer support, allowing multiple users to engage in a collaborative gaming experience.
• Simple to Use: A simple and intuitive interface that makes it easy for users to focus on the fun and not the tech.
• Easy Configuration: See the Portal Configuration and Styling for more information on how to customize your portal's settings and appearance.

Usage

To create a new session, follow these steps:

1. Enter your name, a name and a password for the session.
2. Click Create to create a new session.
3. Copy the generated session ID and share it and the password with your friends.

To join an existing session, follow these steps:

1. Click the connect mode link.
2. Enter your name, the session ID, and the password for the session.
3. Click Connect to join an existing session.

Current Status

This project is just starting and is under active development. We have a few major goals we are working towards currently.

• Basic features to run a TTRPG session.
• NPM packages for both the Portal Client and the Portal Server.
• Simple or automated deployment options.

Once these goals are met we will release a stable v1 release. For now, expect a lot of code changes, bugs, and missing features. Check the TODO to see a running list of features we are working on.

Run Your own Portal

To get started with Dimm City Portal, follow these steps:

1. Clone this repository to your local machine using git clone https://github.com/dimm-city/dimm-city-portal.git.
2. Navigate to the project directory using cd dimm-city-portal.
3. Install dependencies with npm install or yarn install.
4. Start the development server with npm run dev.
5. Open your web browser and visit http://localhost:5173 to access the application.

Contributing

We welcome contributions from the open-source community to help improve and expand this project. If you'd like to contribute, please follow these steps:

1. Fork this repository using the "Fork" button at the top of the page.
2. Create a new branch for your feature or bug fix using git checkout -b feature/your-feature-name or git checkout -b bugfix/issue-number.
3. Make your changes and commit them with clear, descriptive messages.
4. Push your changes to your forked repository using git push origin feature/your-feature-name.
5. Create a pull request (PR) from your branch to the main repository's main branch.
6. Wait for the project maintainers to review and merge your PR.

License

Dimm City Portal by Dimm City RPG is licensed under CC BY-SA 4.0

This means you are free to use, share, and adapt this work as long as you attribute the original authors. See the LICENSE file for details.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

IT Lackey 💻 📖

Scotto1980 🎨

This project follows the all-contributors specification. Contributions of any kind welcome!