Castaway's Hope is an open-source FiveM server pack designed primarily as a learning foundation for developers and server owners. Built on the ESX Legacy framework, this project's mission is to provide a transparent and comprehensive look into how a roleplay server functions from the ground up.
By being fully open-source, it offers a unique opportunity to study, modify, and understand the core mechanics of a server, empowering you to build your own unique and secure roleplay experience.
It is crucial to understand the purpose of this project before you begin.
Important
Professional Services: For those who require a production-ready server with full setup and unique customizations, I am available for freelance services. Please feel free to reach out to discuss your project. Contact: To get started, please join our Community Discord and open a ticket in the designated channel. We'll be happy to discuss your needs there.
- Transparent Codebase: Study the interactions between different scripts and learn best practices.
- Solid Foundation: Use this pack as a boilerplate to develop your own unique scripts and features without starting from zero.
- Complete Examples: Contains all the fundamental features of a roleplay server for you to deconstruct and learn from.
Warning
Because this is a public, open-source project, its code, logic, and event names are known to everyone. Deploying this pack on a live, public server without significant modifications is not recommended and poses a security risk.
True server security comes from well-written, audited code and unique implementation—not from hiding it. This pack provides the starting point to learn and achieve that.
To make this pack "production-ready," you should:
- Audit the Code: Review critical events and functions to ensure they follow secure practices (e.g., proper server-side validation).
- Customize Core Logic: Change how certain features work to make your server unique.
- Rename Critical Server Events: This is the most important step to prevent targeted exploits developed for this public base.
Before you begin, you must set up your local development environment. This includes the FiveM server files and a database server.
-
FiveM Server Artifacts: You need a recent server build to ensure compatibility and stability.
-
Local Database Server: A database is required to store all player and server data.
- For a modern, fast, and flexible workflow, we highly recommend using Laragon. It comes bundled with the HeidiSQL database manager, making setup much simpler.
- ➡️ Download Laragon (Full Edition) Here
- (The classic XAMPP is also a viable alternative if you are more comfortable with it.)
- 📖 Educational Focus: Built with clear, organized code to serve as a powerful learning tool for new and intermediate developers.
- Stability & Performance: Optimized for low resource usage (ms), demonstrating good practice in resource management.
- Realistic Inventory System: Powered by [ox_inventory], providing a modern and intuitive item management experience.
Note
Remember, this pack is intended for local development and learning. Before considering a live deployment, please read the Project Goal section above.
A step-by-step video installation guide is coming soon!
All essential server settings are managed in a separate configuration folder. This keeps your sensitive keys safe and separate from the core pack files.
- In the main project directory, locate the
kyg-setup-samplefolder. - Rename this folder to
kyg-setup. - Open the
connections.cfgfile inside your newkyg-setupfolder and fill in your details. - Open the
admins.cfgfile inside your newkyg-setupfolder and fill in your details.
Important
The kyg-setup folder is already included in the .gitignore file. This is to prevent you from accidentally committing your sensitive keys and passwords to a public repository. The kyg-setup-sample folder is what should be updated with any template changes.
This project would not be possible without the incredible work of numerous developers in the FiveM community. We respect and adhere to the license of every resource used.
A complete and detailed list of all included resources, their authors, and their respective licenses can be found in the separate CREDITS.md file.
Important
We strongly encourage you to support the original creators of these resources.
The Castaway's Hope project as a whole is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
This "ShareAlike" license is chosen to encourage a learning environment. If you adapt this work, you are encouraged to share your own educational contributions back to the community under the same terms.
Developed by the Kyogo Island Community | Join us on Discord to learn and share!