https://github.com/abdelaz3r/forbidden_lands
Web companion for your Forbidden Lands journey
https://github.com/abdelaz3r/forbidden_lands
elixir forbidden-lands rpg rpg-text
Last synced: 19 days ago
JSON representation
Web companion for your Forbidden Lands journey
- Host: GitHub
- URL: https://github.com/abdelaz3r/forbidden_lands
- Owner: abdelaz3r
- License: mit
- Created: 2023-01-04T16:21:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T21:01:29.000Z (about 1 year ago)
- Last Synced: 2025-04-07T05:11:13.596Z (about 1 month ago)
- Topics: elixir, forbidden-lands, rpg, rpg-text
- Language: Elixir
- Homepage:
- Size: 61.6 MB
- Stars: 13
- Watchers: 1
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Forbidden Lands RPG Companion App
Welcome to the Forbidden Lands RPG Companion App documentation!
This repository hosts a personal project aimed at enhancing your experience while playing the thrilling role-playing game [Forbidden Lands](https://freeleaguepublishing.com/en/games/forbidden-lands/). Whether you're a player or a Game Master (GM), this app is designed to enrich your sessions and streamline certain aspects of gameplay.
# About the Project
This project is created with a passion for the Forbidden Lands universe. While it's not intended to be a fully-integrated GM companion, it serves as a valuable tool to aid GMs and players alike in various aspects of the game.
## Demo access
You can find a demo instance at this address: [forbidden-lands-companion.fly.dev](https://forbidden-lands-companion.fly.dev/en/).
## Contributions
Contributions to this project are more than welcome! If you're interested in adding your expertise and insights, please ensure that your contributions align with the project's guidelines.
## Features
During your Forbidden Lands RPG sessions:
- Manage View for GMs:
- Keep track of game time (I implemented the custom Forbidden Lands calendar as described [here](https://www.darkforesttales.com/post/keeping-time-in-the-forbidden-lands)),
- Set the perfect ambiance with background music (music not included),
- Manage stronghold sheet,
- Manage stronghold resources with custom rules,
- Register group events.
- Dashboard View for Players: For players, the app provides a wide map view, the ability to immerse themselves in the ambiance, and a clear way of the calendar. This view is ideally suited for projection using a beamer or a computer screen, making your game world come to life.
Beyond the tabletop sessions:
- Event Tracking: Easily record and keep track of events that unfold throughout your campaign. Stay organized and never miss a pivotal moment.
- Event Browsing: Browse through past events, reminisce about your adventures, and use this feature as a reference for your ongoing gameplay.
- Adventure Sharing: Share the story of your adventure to the world.
# Installation
This project uses [Elixir](https://elixir-lang.org/) and the [web framework Phoenix/LiveView](https://www.phoenixframework.org/).
## Minimal Setup
To get started, follow these steps:
- Install dependencies with `mix deps.get`.
- Create and migrate your database with `mix ecto.setup`. Make sure you have PostgreSQL installed and configured. Default configuration for the development environment can be found in `config/dev.exs`.
- Start the Phoenix endpoint with `mix phx.server` or within IEx using `iex -S mix phx.server`.
You can access the app by visiting [`localhost:4000`](http://localhost:4000) in your browser.
## Adding Music Playlists
Please note that due to copyright issues, no music files are provided in that repo. You can set up your own playlist:
1. Create a `musics` folder within the `priv/static` directory.
2. Inside the `musics` folder, create subdirectories for each playlist. The name of each subdirectory will be the name of the playlist.
3. Place your mp3 files within these subdirectories to represent the music for each playlist.
After setting up your playlist folders, run the following mix command to generate the `mood.txt` file:
```bash
mix fl.process_playlists --source [source_directory] --target [target_file]
```
## Accessing the Admin Panel
During development, the admin username is `admin`, and the admin password is `1234`. You can modify these credentials in the `config/dev.exs` file as shown below:
``` elixir
# User and password for admin auth
config :forbidden_lands,
username: "admin",
password: "1234"
```
# Production
If you intend to deploy the app, please refer to the [official Phoenix deployment guides](https://hexdocs.pm/phoenix/deployment.html).
However, the app is already configured for fast deployment on [fly.io](https://fly.io/). An example `fly.toml` configuration file can be found.
## Admin Panel Access in Production
During deployment, you'll need to set environment variables to access the admin panel. Here's an example of how to do it for fly.io:
``` bash
fly secrets set ADMIN_USERNAME={some_user}
fly secrets set ADMIN_PASSWORD={some_password}
```