https://github.com/floriansw/server-donation-tool

A tool to transform your game-server donations into a self-service experience for your donators.
https://github.com/floriansw/server-donation-tool

cftools dayz discord donations

Last synced: 8 days ago
JSON representation

A tool to transform your game-server donations into a self-service experience for your donators.

• Host: GitHub
• URL: https://github.com/floriansw/server-donation-tool
• Owner: FlorianSW
• License: mit
• Created: 2021-06-27T16:22:02.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-20T16:21:40.000Z (6 months ago)
• Last Synced: 2024-05-20T19:30:35.059Z (6 months ago)
• Topics: cftools, dayz, discord, donations
• Language: TypeScript
• Homepage: https://floriansw.github.io/server-donation-tool/
• Size: 3.17 MB
• Stars: 19
• Watchers: 6
• Forks: 3
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Server donation tool

[![Discord](https://img.shields.io/discord/729467994832371813?color=7289da&label=Discord&logo=discord&logoColor=ffffff&style=flat-square)](https://go2tech.de/discord)

[![Docker Pulls](https://img.shields.io/docker/pulls/droidwiki/server-donation-tool?style=flat-square)](https://hub.docker.com/r/droidwiki/server-donation-tool)

[![Tests](https://img.shields.io/github/workflow/status/FlorianSW/server-donation-tool/Test?label=tests&style=flat-square)](https://github.com/FlorianSW/server-donation-tool/actions/workflows/test.yml)

[![Documentation](https://img.shields.io/badge/docs-deployed-success?style=flat-square&logo=readthedocs)](https://floriansw.github.io/server-donation-tool/)



    



This server donation tool is meant to make it easier for gaming communities to allow their members to donate and earn differnet perks for their donation.

It seamlessly integrates with different platforms in order to automatically provision and setup perks for donators to reduce manual efforts for community admins and moderators.

## Key Features

- Self-services, guided donation on a modern website

- Integrated with PayPal for easy, self-service and secure payments

- Fully configurable packages, including configuring perks a donator earns, and the amount one needs to donate

- Perks available: Priority Queue (based on CFTools Cloud), Discord roles

- Discord notifications

## Installation & Configuration

The `config.full.yml` provides extensive documentation for each configuration option.

With the `config.example.yml`, there is a minimum configuration file, where you just need to replace the placeholder values to get started (it does not contain all the possible configuration values).

Documentation, as well as a getting started guide is [available in the documentation](https://floriansw.github.io/server-donation-tool/).

## Support and Collaboration

If you have a question regarding the use or the setup of this tool, feel free to [join my Discord](https://go2tech.de/discord) and get the `Tools` role in the #get-your-roles-here channel.

I'll be happy to assist you if I can with your question there :)

The initial configuration of the tool might look a bit overwhelming, but I'm happy to help you with whatever problem you're facing, just contact me.

Given you think you found a bug, a missing feature or something that can be improved, I encourage you to open an issue in [this Github repository](https://github.com/FlorianSW/cftools-server-donation).

Please, do not use issues for your questions or for getting support.

Given you're a developer and want to contribute code to this project, feel free to do so.

Simply fork the project, make your code changes and open a pull request against this repository.

I appreciate your help and support and will try to review your pull request as soon as I can.