Skip to content

Latest commit

 

History

History
134 lines (103 loc) · 6.37 KB

README.md

File metadata and controls

134 lines (103 loc) · 6.37 KB
Raw

FiveNet Logo

FiveNet

Container Images on GHCR.io Helm Logo Discord fivenet.app Website

Go Nuxt.js Nuxt UI Pro TypeScript NATS.io Docker

Roadmap

Things on the roadmap may or may not be implemented/changed/removed without warning. For the roadmap click here.

Features

Be sure to checkout the website for an uptodate list of features with screenshots here.

Show partial feature List
  • Authentication
    • Separate "accounts" table that allows users to log in to the network
    • Last Char lock, prevent users from switching to chars other than the last one active on the server
  • "Content Moderation" access for server admins
    • Use a list of ESX user groups in the config
    • Allow them to switch jobs on the fly to always the highest job rank
    • Allow them to edit/ delete any user content
  • Livemap
    • See your colleagues (for now using Copnet VPC Connector's data)
      • Create a table model for our player location table
    • Multiple different designs
    • Display dispatches (from GKS phone for now)
    • See other jobs' positions and/ or dispatches
    • Animated Marker when they move
    • Search markers
    • Postal Search
  • Permissions System
    • Based on Job + Job Rank/ Grade
  • User Database - 1. Prio
    • Search by
      • Name
      • Wanted State
    • Display a single user's info
      • Show a feed of the activity of the user (e.g., documents created, documents mentioned in)
    • Wanted aka "additional UserProps"
      • Allow certain jobs to set a person as wanted
      • Add toggle to display only wanted people
  • Vehicles Search
    • By Plate
    • By Citizen on the citizen profile
  • Documents ("Akten")
    • Each document is independent and has no direct parent or responses
      • Users can leave Comments on documents
    • Documents can reference each other ("document activity feed"), e.g., DOJ asks for a blood test on a patient, LSMD responds by creating the patient blood test result document and references the DOJ response
    • Templates
      • Add requirements for templates
    • Sharing
      • Sharing with the same job automatically
      • Sharing with users/ citizens (e.g., Patientenbefund is shared with the Patient, the lawyer and the DOJ)
    • Category System (no directories/ paths)
      • Sub-categories - One level of categories that are sorted by names
    • Functionality
      • Create Documents with access
      • Edit Documents
        • With access modifications
        • Set/ Update document category
        • Set Access for Jobs and Users
      • Document Comments
        • View Document Comments
        • Post Document Comments
        • Edit Document Comments
  • "Completor" Service
  • Breadcrumbs
    • Use the closest thing to a page title (e.g., when viewing a user or editing a document) to build the breadcrumbs
  • "Faction Leader Control Panel" aka "Rector Service"
    • Permission Editor for the job ranks (Rector)
      • Can view the permissions
      • Can edit the permissions
    • Templates (DocStore)
      • Create templates
      • Edit templates
    • Category (DocStore)
      • Create Categories
      • Edit Categories
      • Delete categories
  • FiveM Integration plugin
    • Livemap - Player position tracker plugin

And more features, check out Getting Started - FiveNet website.

Installation

Container Images

Container images are available via GHCR.io fivenet-app/fivenet image.

Helm Chart

Helm chart is available in the separate GitHub fivenet-app/charts repository.

Plugins

Gameserver plugins are available in the separate GitHub fivenet-app/plugins repository.

Development

Please see development documentation.

Translations (i18n)

Want to help translate FiveNet or fix a translation issue? You can join the translation group by heading over to FiveNet's POEditor.com project here.

Thanks to POEditor for providing FiveNet with a free translation project!

POEditor Logo

Security

If you find a vulnerability or a potential vulnerability in FiveNet, please see the security release process.

Credits

  • Leaflet Livemap Code CRS: Based upon NelsonMinar's Map Viewer Gist and VPC's CopNet/ MedicNet livemap code, and a lot of Leaflet CRS related Stackoverflow posts.

License

Code licensed under Apache 2.0 license, see LICENSE.

Licenses of used libraries, code and media can be found in the public/licenses/ folder.