Armoury - The Open Source, FiveM Roleplay Gamemode (Typescript/Non-ESX/Own framework)
WARNING: This project is in an ALPHA phase. You are more than likely to encounter bugs on the server. If you do find such bugs, feel free to let us know or even create a pull request for it!
Github Repository | Patreon | Documentation | Discord
1. What is this?
Armoury started off as an independent project for the sole reason of honing our programming skills by creating something entirely from scratch, without the use of any existing framework, and based (almost) entirely on a Typescript codebase.
2. Is this ESX-friendly?
No, it is not. However, the framework we have created is incredibly easy to dive into.
Also, if you have used Angular before, it might be even easier to use our in-house framework, due to the inspiration we have taken from the popular web app development platform. Our project also synergizes with Angular-made UIs.
3. Is this finished?
This project is currently in an ALPHA phase. This means that even though it’s in a playable state, you might encounter bugs here and there. Also, there are still features needed to be done in order for it to be complete.
Because it’s an open source project, everyone is welcome to propose modifications by creating pull requests on our repository.
– Features –
Housing System
A player can purchase a house by simply accessing the house menu in front of the house. The player can own an unlimited amount of houses, but their daily taxes increase with each house owned.
House menu
A house owner has access to a menu (press M inside a house) which lets them visualize several pieces of information about their house. They can also set their house for sale (another player will then be able to buy the house even while the owner is offline), sell the house to the bank immediately (they receive only 50% of its value!), set the rent price, buy a pet and more.
Businesses
Players can also own businesses (convenience stores, the CNN, the Electricity Company, the Phone Company, etc). In the video below, the player buys the Electricity Company. The Electricity Company’s income comes from electricity bills.
Pets
A house owner can buy a pet which permanently resides in their house. Be careful! Your pet could be taken away if you don’t feed them or don’t provide them drinking water permanently.
Extra spaces for depositing stuff
For example, here’s a fridge.
Factions
Armoury provides base classes which help you create your own faction in seconds. Additionally, Armoury includes an example faction inside the repository (more to come!), which is the Taxi Cab Company.
Taxi Cab Company
The job of a Taxi Cab Company member is simple: Get in your vehicle, find a client, deliver them to their desired location, and then repeat.
The Taxi Cab Company’s vehicles (and all other faction vehicles in general) can normally be driven by anybody as long as they have a key. That’s why every faction has 2 keys for every vehicle inside their HQ’s key locker (one original and one backup). Whenever a Taxi Cab Company member wants to begin working, they need to grab a key from the locker in order to drive the vehicle assigned to it.
After grabbing the faction’s vehicle key, the player gains the ability to lock/unlock it (F3 key). Any player who somehow manages to receive that vehicle key (robbing the driver/simply having the key given to them) can also lock/unlock the vehicle. The faction member gains full responsibility over the vehicle!
A Taxi Cab Company member can go on duty and activate the taximeter in order to tax clients.
Jobs
At the moment, the Armoury gamemode provides two basic jobs for players to make money.
Trucker Job
The player can get employed as a Trucker, which does long routes in order to provide products to the city dock.
Carrier Job
The player can also get employed as a Carrier, which does shorter routes from the dock to each business in the city, delivering them the products from the city dock that Truckers had provided. Businesses eventually run out of products, which means that Truckers and Carriers need to constantly be working. If this doesn’t happen, business owners need to find a way to incentivize Truckers and Carriers!
Phones
Players can use their phones in order to make calls, send messages, call for services, do mobile banking transactions and more.
Personal Vehicles
Players can buy vehicles either from other players or from the dealership.
Vehicle Trunks
A player can deposit money, weapons, snacks, drinks and other items inside their vehicle’s trunk. Always lock your vehicle! Elseway, other players would be able to grab items from your trunk!
Inventory
The inventory system does… well… everything any other inventory system does. You can see your assets (house keys, business keys, vehicles, weapons), use (usable) items (food, water, alcohol), check your cash and more. Also, it’s implemented on a drag ‘n’ drop logic.
Convenience stores
Convenience stores (these are player-owned businesses!) provide unlimited products such as snacks, drinks, alcohol products and more.
Thirst & Hunger
Armoury includes a Hunger & Thirst system. The process is as simple as it can be: Hunger and Thirst values decrease over time. In order to satisfy these stats, the player can use food and drinks from their inventory.
Context menus
Authentication
Armoury provides a clean and simple UI for registering and logging in. Video preview here
A clean and organized codebase, powered by an in-house framework
Developing stuff with our in-house framework works as a breeze. Open up either your server or client controller and make use of our shortcuts in order to create your systems in no time.
Minimalistic, beautiful UIs made in Angular
This project’s whole UI was done with high design standards in our mind. Also, we have used Angular in combination with Angular Material for every piece of UI in the gamemode, which enhance User Experience and Responsiveness while also remaining optimized.
maybe that have permission?
