Giter VIP home page Giter VIP logo

fiverm's Introduction


FiveM resource manager.
Explore the docs »

View Demo · Report Bug · Request Feature

Contributors Forks Stargazers Issues GPL 3.0

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Support me
  7. License
  8. Contact
  9. Acknowledgments

About The Project

fiverm is a FiveM resource manager for your server. It allows you to manage your FiveM resources in a simple and easy way. It is written in Go for performance and size, and built with Cobra.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

For now the only way to install fiverm is from the actions page or by downloading it from the release list.

(back to top)

Usage

Creating a new project

To create a project (resources.json file) you should run the next command in your server folder (along with the server.cfg file):

user@host:~$ fiverm init

If you want to create the project again where one already exists, you can use the --force flag to overwrite the project. This will delete the project you have created in that folder, but WILL NOT DELETE ANY INSTALLED RESOURCES.

user@host:~$ fiverm init --force

Adding resources to the project

You need to run the commands in the folder where the project is created with the fiverm init command

To install resources in a created project, use the install command followed by the username and the repository name as in the example:

user@host:~$ fiverm install eschiclers/zrp_demo

If you want the resource to be installed in a custom folder you can use the --folder flag and the folder name without [ ] as in the example:

user@host:~$ fiverm install eschiclers/zrp_demo --folder zrp

And this will install the resource in the [zrp] folder.

(back to top)

Roadmap

For server

  • Project creation
  • Install resources
    • In custom folder
    • Install from folder without download
  • Delete resources
  • Update resources

For resource creation

  • Resource creation

I also want to create a web page as a directory that collects the public resources and thus be able to list them all and create pages such as "the most installed resources".

But for that you need to have servers. Which means spending money. That's why there is a section to support the project through ko-fi.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Support me

You can support me and this project through ko-fi

ko-fi

License

Distributed under the GPL 3.0 license. See LICENSE for more information.

(back to top)

Contact

Chicle - @Eschiclers - [email protected] - Telegram: @Eschiclers

Project Link: https://github.com/Eschiclers/fiverm

(back to top)

Acknowledgments

(back to top)

fiverm's People

Contributors

eschiclers avatar

Stargazers

 avatar

Watchers

 avatar

fiverm's Issues

Remove `workingdirectory.go` file

Remove the workingdirectory file and the GetWorkingDirectory() function. It takes more time to use this than just using os.Getwd() and wirte more code using GetWorkingDirectory(). Lmao. Why did I think it would be a good idea?

Install resource from master using --master flag

Using the --master flag allows you to install a resource by downloading files from the master branch and not from releases.

Example:

user@host:~$ fiverm install eschiclers/zrp_demo --master

This will download the files from the master branch in the repository eschiclers/zrp_demo and install it.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.