Code Monkey home page Code Monkey logo

docs's Introduction

~ CodersClash ~

Discord Bot Coding Tournament


Sponsored by

v.1.1 - 19.06.2018


Index

  1. Einleitung
  2. Ablauf
  3. Regeln
  4. Die Anforderungen
  5. Preise
  6. Punktesystem
  7. Anmeldung

Einleitung

Wir, das Staff-Team von zekro's Dev-Server, wollen gemeinsam mit euch ein kleines Tournament veranstalten, bei dem 2 oder mehr Teams einen Discord Bot erstellen sollen, welche dann in einer Testphase von den Membern des Servers bewertet werden können. Zu gewinnen wird es dabei natürlich auch etwas geben, jedoch soll es bei dem Turnier primär um den Spaß an der Sache gehen. ;)


Ablauf

Phase 1: Teamfindung

Zuerst werden sich Teams aus mindestens 2 und maximal 5 Leuten bilden. Ihr könnt euch dann hier als Team anmelden.

Diese Phase wird vom 18. Juni 2018 zum 22. Juni 2018 (1 Woche) andauern.

Phase 2: Entwicklungsphase

In dieser Phase entwickeln die Teams die geforderten Features der Bots, welche vorher zufällig aus einer Liste von Features (z.B. XP-System, Autorole, Voting-System, ...) ausgewählt werden und für alle Teams gleich gelten. Während der Entwicklungsphase sollten die Repositories natürlich Closed Source sein.

Diese Phase wird vom 23. Juni 2018 zum 21. Juli 2018 (4 Wochen) andauern.

Phase 3: Testphase

In dieser Phase werden die Bots an das Test-Team übergeben. Das heißt, die Bots werden auf einem extra Server installiert und gehostet. Dann werden die Bots auf dem Dev-Discord veröffentlicht und allen Nutzern zur Verfügung gestellt. Zudem werden ab dann die Repositories der Bots auf GitHub veröffentlicht und verschiedenen Tests unterzogen, welche unten detailliert genannt werden.

Diese Phase wird vom 22. Juli 2018 zum 12. August 2018 (3 Wochen) andauern.

Phase 4: Votingphase

In dieser Phase können alle Member des Servers abstimmen, welchen Bot sie am besten fanden. Test- und Auswertungsphase sind deswegen voneinander getrennt, da natürlich die Bots auch auf ihre Stabilität und ihr "Durchhaltevermögen" getestet werden sollen.

Diese Phase wird vom 13. August 2018 zum 17. August 2018 (1 Woche) andauern.

Somit werden am 18. August 2018 die Ergebnisse veröffentlicht.


Regeln

  • Selbstverständlich müssen die Bots in den gegebenen Environments selbstständig und stabil laufen.
  • Die Bots müssen einen Test-Modus mitbringen, welche in der CI genutzt werden können.
  • Die Bots müssen auf Linux Debian laufen.
  • Sollte ein Bot in der Testphase crashen wird dieser nur neu gestartet, wenn es sich dabei um einen Disconnect, Timeout oder sonst einen Fehler der Umgebung handeln sollte. Ansonsten ist ab dem Zeitpunkt des Crashes die Testphase für den Bot beendet, darf jedoch beim Voting noch Teilnehmen.
  • Generell dürfen alle Packages der Languages und Wrapper benutz werden. Sollte ein Team unbedingt 3rd-Party-Libraries benötigen, so können diese in Absprache mit dem Discord-Staff-Team benutzt werden.
  • Der Bot muss eine Konfigurationsdatei beinhalten, mit der Dinge wie Token, Prefix, Datenbankdaten und Botowner einstellbar sind.
  • Die Bots müssen eine Dokumentation ihrer Commands mitbringen (z.B. in Form einer Website, online PDF oder eines Gist auf GitHub bzw. in der Readme oder im Wiki der Repository).

Das Testsystem

Der Testserver wird von signaltransmitter.de zur Verfügung gestellt.

System debian-8.0-x86_64
Type OpenVZ
RAM 4 GB
CPU 4 VCores
Anbindung 250 MBit/s Up/Down
Software - MySql/MongoDB
- Java
- Go
- Rust
- Ruby / Gem
- Python / PIP
- NodeJs / NPM
- Jenkins
- git
- screen
- ServerManager2

Erlaubte Dependencies und API Wrapper

Folgende API Wrapper stehen zur Auswahl:

Language Library
Node.js discord.js
Eris
discordie
Java Discord4J
JDA
Javacord
Go discordgo
Python discord.py
Rust discord-rs
serenity
Ruby discordrb

Zudem sind Libraries um auf eine Datenbank zugreifen zu können erlaubt.

Repository Tests

Achtung: Das Team kann entscheiden ob sie als CI travis-ci oder jenkins nutzen wollen.

System Type Description
travis-ci CI - Build
- Start
- Tests
jenkins CI - Build
- Start
- Tests
codacy Code Review and Analysis - Code Review
- Style Analysis
- Error check

Die Anforderungen

Die folgenden Anforderungen muss der Bot beinhalten:

  • Eine Config
    In dieser der Token des Bots, der Owner, die Credentials zu API's und zu der Datenbank und weitere beliebige Einstellungen getätigt werden können.
  • Command Parser und Event Handler
    Selbstverständlich sollte der Bot die Grundbausteine nahezu aller Bots beinhalten, um funktionieren zu können.
  • Datenbankanbindung an MySql oder MongoDB
    Sollte für die Umsetzug der Features die Speicherung von Daten nötig sein so sollte dies über eine Datenbank erfolgen.
  • Permission System
    Natürlich muss es eine Verwaltung geben, welche Nutzer was machen können. Wie ganau dieses System umgesetzt ist ist Entscheidungssache des Teams.

Aus folgender Liste werden dann zufällig 4 Anforderungen gezogen, welche die Bots beinhalten müssen.

  • XP-System Complex
    Vergabe von XP-Punkten an User. Unter welchen Kriterien diese erfolgt und welche Belohnungen dabei ausgeschüttet werden ist Endscheidung des Teams.
  • Music Command Complex
    Einen umfangreichen Music-Command mit dem man von Online-Platformen wie z.B. YouTube Musik (auch in form von Playlists) streamen kann.
  • Ein Game-Feature Complex
    Es soll ein Chat-Game erstellt werden, welches User zusammen spielen können. Welches genau hängt von der Kreativität des Teams ab. ;)
  • Message-Filter Complex
    Filtern von Messages auf unerlaubte Links, Schimpfworte, ...
  • Voting System Medium
    Ein System, mit dem User Votes erstellen können und unter diesen Abstimmen können.
  • Autochannel-System Medium
    Automatisches erstellen von teporären Voice-Channels beim Joinen des Root-Channels (z.B. wie beim RubiconBot oder zekroBot2).
  • Report-System Medium
    Reporting von Usern und aufzeichnung in Datenbank.

Zudem soll jeder Bot mindestens 2 weitere, inovative Features haben. Um was es sich dabei handelt ist vollkommen den Teams überlassen, es sollte jedoch etwas sein, was man bis jetzt noch nicht gesehen hat.

Natürlich können auch noch weitere dinge in den Bot implementiert werden, welche hier nicht aufgelistet sind. Es geht ja schließlich auch um das Gesamtbild des Projekts. ;)


Punktesystem

CI Test (Travis / Jenkins) - Build
- Run/Login
- Tests
+ 100 P
+ 100 P
+ 100 P
codacy - A
- B
- C
- D
- E
- F
+ 150 P
+ 100 P
+ 50 P
+ 10 P
0 P
0 P
User Voting Anteil der Stimmen des Bots multipliziert mit 1000 Punkten. Bot-Stimmen / Gesamtstimmen * 1000 P
Staff Voting Anteil der Stimmen des Bots multipliziert mit 300 Punkten. Bot-Stimmen / Gesamtstimmen * 300 P
Bot-Crash während Testphase - 500 P
Bot startet nicht auf Test-System Disqualifikation
Gesamtzahl erreichbarer Punkte 1750 P

Preise

Wie schon gesagt soll es bei dem Event nicht um einen großen Preis gehen, sondern eher um den Spaß und die Ehre. Jedoch gibt's natürlich trotzdem ein paar Goodies für die Gewinner:

  • Alle Teilnehmer des Gewinnerteams bekommen die seperat angezeigte Rolle CodersClash S01 Gewinner
  • Der Gewinner-Bot bekommt zudem eine extra Bot-Rolle mit erweiterten Rechten
    Dabei ist zu beachten, dass der Bot entweder kostenlos vom Server-Team gehostet werden kann oder von den Erstellern selbst unter der Bedigung, dass das Admin-Team Zugriff auf den Server und den Bot hat.
  • Zudem wird der Bot in einem seperaten Video auf zekro's YouTube-Kanal vorgestellt

Anmeldung

Anmeldung

docs's People

Contributors

zekrotja avatar

Watchers

 avatar

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.