hydractify / forgottenserver

Repository for maintaing our custom open tibia server using forgottenserver.

Introduction

This is a Discord application for experimenting ideas on and serve our community needs.

Requirements

• Rust
• PostgreSQL

Getting started

Firstly what you want to do is clone this repository:

git clone https://github.com/Hydractify/hydractify.git

From here you will configure the application with config.toml, you can use config.example.toml as a reference. Here you will set:

• The application's token (token);
• The database URL (database_url), i.e. postgres://username:password@localhost/database_name;
• Module configuration.

Once that's done, you need to install diesel_cli for automatically generating typings and running our SQL to make sure all tables are configured. You can install it through cargo:

cargo install diesel_cli --no-default-features --features postgres

Once that's done, ensure it's binary in your $PATH then run:

diesel migration run

Now you can just run the application! If you're not familiar with Rust, you can run it through your terminal with:

cargo run

Modules

Self Role

This module is configured via [self_roles] in config.toml, which has two fields:

1. enabled
   • Whether the module is enabled or not. The commands are still registered, maybe they shouldn't.
2. channel_id
   • The ID of the channel where the self role message should be deployed.

When enabled and the message is deployed then when a Discord user interacts with the module they will have that certain role added to them or removed.

Slash commands

To configure and manage the message with the self assignable roles you must use the /selfrole slash commands, these being:

1. /selfrole show
   • Lists the registered self assignable roles.
2. /selfrole deploy
   • Deploys the message with the self assignable roles, optionally receiving a message ID to edit an existing one.
3. /selfrole cleanup
   • Removes from the list all roles that have been deleted.
4. /selfrole remove
   • Removes a specific role from the self assignable role list.
5. /selfrole add
   • Adds a specific role into the self assignable role list.

Starboard

This module is configured via [starboard] in config.toml, which has four fields:

1. enabled
   • Whether the module is enabled or not.
2. channel
   • The channel that starboard messages should go to.
3. emojis
   • An array containing the emotes that trigger a starboard message, these can be an UTF-8 character like ⭐ or a custom emote like <a:a_kirbyStar:894087344909606912>.
4. threshold
   • How many emotes are needed to trigger a starboard message.

Special thanks

This implementation is heavily based off of etternabot, it was a great starting point for me to understand how poise and serenity work!

forgottenserver's Issues

Implementation of the quest "The Rookie Guard"

Currently the whole quest is missing, nothing related to it is implemented.

Full walk-through can be found here, however I advise to create a Rookgaard character in the vanilla to have a better POV/understanding of the quest.

Venore implementation

Issue to centralize our efforts into implementing all content (NPCs, Quests, etc) related to Venore town.

Roadmap can be found in the project linked to this issue.

Status

• 🔴 - Tested and developed;
• ❌ - Has problems;
• ⭕ - Developed;
• ♨️ - In development;
• ❓ - Unknown.

Issue

• ⛔ - No issue open.

NPCs

Inside town

Name	Status	Issue
Captain Fearless	❌	⛔
Guide Elena	❓	⛔
Uncle	❓	⛔
Rodney	❓	⛔
Rose	❓	⛔
Livielle	❓	⛔
Carina	❓	⛔
Rokyn	❓	⛔
Odemara	❓	⛔
Allen	❓	⛔
Yulas	❓	⛔
Borkas	❓	⛔
Frans	❓	⛔
Digger	❓	⛔
Smiley	❓	⛔
Chatterbone	❓	⛔
Vladruc	❓	⛔
Warbert	❓	⛔
Xed	❓	⛔
Romella	❓	⛔
Yanni	❓	⛔
Abran Ironeye	❓	⛔
Alwin	❓	⛔
Shiantis	❓	⛔
Nelliem	❓	⛔
Chephan	❓	⛔
Julian	❓	⛔
Leeland	❓	⛔
Cristoph	❓	⛔
Dove	❓	⛔
Dustrunner	❓	⛔
Lightfoot	❓	⛔
Nurik	❓	⛔
Maria	❓	⛔
A Strange Fellow	❓	⛔
Zebron	❓	⛔
Urkalio	❓	⛔
Asrak	❓	⛔
Arnold	❓	⛔
Yberius	❓	⛔

Remove premium unfairness

This issue is reserved to discussing the removal of premium features or "balancing" of such feature.

Aspects like premium only regions are to be removed as well as removing the limitations in certain places like the auction house which only premium members can add items into.

Rookgaard Food

We need to implement all the Food located in Rookgaard.

All of these Foods should be implemented in TFS already, however if not, they are likely implemented in orts/server but we have to update those files to the latest TFS version.

Here is the list of Food: https://tibia.fandom.com/wiki/Rookgaard#Food

Problems with The Beginning Quest

No response to keyword 'hurt'

Rookgaard Achievements

We need to implement all the Achievements located in Rookgaard, a sum of 21 Achievements exist in the town.

All of these Achievements should be implemented in orts/server but we have to update those files to the latest TFS version.

Here is the list of Achievements: https://tibia.fandom.com/wiki/Rookgaard#Achievements

Rookgaard Equipment

We need to implement all the Equipment located in Rookgaard,.

All of these Equipments should be implemented in TFS, however if not, they are likely implemented in orts/server but we have to update those files to the latest TFS version.

Here is the list of Equipment: https://tibia.fandom.com/wiki/Rookgaard#Equipment

Rookgaard Creatures

We need to implement all the Creatures located in Rookgaard.

All of these Creatures should be already implemented in TFS. However if there is any missing, orts/server should have it implemented but we have to update those files to the latest TFS version.

Here is the list of Creatures: https://tibia.fandom.com/wiki/Rookgaard#Creatures

Rookgaard NPCs

We need to implement all the NPCs located in Rookgaard, a sum of 25 NPCs exist in the town.

All of these NPCs were implemented in orts/server but we have to update those files to the latest TFS version. Some of these NPCs also have flawed conversations, either lacking on dialog or just straight up no code for some dialog.

Here is the list of NPCs: https://tibia.fandom.com/wiki/Rookgaard#NPCs

Rookgaard implementation

Issue to centralize our efforts into implementing all content (NPCs, Quests, etc) related to Rookgaard.

Roadmap can be found in the project linked to this issue.

Status

• 🔴 - Tested and developed;
• ❌ - Has problems;
• ⭕ - Developed;
• ♨️ - In development;
• ❓ - Unknown.

Issue

• ⛔ - No issue open.

Quests

Main quests

Name	Status	Issue
Bear Room	❌	⛔
Captain Uglues Treasure	❓	⛔
Child of Destiny	♨️	⛔
Combat Knife	🔴	⛔
Doublet	🔴	⛔
Dragon Corpse	🔴	⛔
Goblin Temple	🔴	⛔
Katana	🔴	⛔
Minotaur Hell	🔴	⛔
Minotaur Hell	🔴	⛔
Rapier	🔴	⛔
Sanctuary of the Lizard God	❓	⛔
The Rookie Guard	❓	#13
The Beginning Quest	❌	#10

Exchange quests

Name	Status	Issue
Pick	🔴	⛔
Present	❓	⛔
Short Sword	❓	⛔
Small Health Potion	❓	⛔
Studded Legs	❓	⛔
Studded Shield	❓	⛔

Addon quests

Name	Status	Issue
Citizen Outfits	❓	⛔
Druid Outfits	❓	⛔

Rookgard Actions

This issue is reserved to implementing the actions related to Rookgaard from orts/server.