Repository files navigation

Chat-Log System made by AunaCraft

ThisChatLog Project servers the purpose to provide an easy to use and reliable backend rest-api.Creating that in order to look forward to implement it to theAunaCraft Chat system.

This project does not contain any type of plugin-implementation for bukkit, bungee or velocity services.It is only providing the backend for an easy to implement frontend/plugin.

The ChatLog System is functioning through a rest-api based onspring.The minecraft server implements a boostrap to communicate with the rest-api.You are able to use your whole creativity to create the system at minecraft layer.

To understand what you have to save/send when listening to messages this Class Card should help.You may wonder why we also put the displayName into any message, well the main reason for this was tobe able to record nicknames, nicks and to provide an ability for being able to represent the chat messagemore realistic than only fetching the uuid.

If you try getting a chat log from the server you are getting an ChatLog Object

You have to use the API through HTTP-Requests. (Cause its an Rest API wich makes kinda sense lol)

So here is a little overview of request you are able to make

Your HTML-Request:GET http://<yourServer>:<yourPort>/chatlog/v1/get/{logID-here}/

Response Example:

{"id":"e24026ec","messages":   [    {"time":1647281712369,"uuid":"6d34d7c6-a73a-4065-af94-60c977329c40","displayName":"FebanUHD","message":"Hello, this is a example message!!!"    },    {"time":123454678910,"uuid":"859c974c-2e32-4599-ac2e-05c7f06aead8","displayName":"ytendx","message":"Test"    }  ]}

To create a chatlog, you need an API key and then send a post request.Your POST-Request:POST http://<yourServer>:<yourPort>/chatlog/v1/create/{api-key-herer}/

Content-Type:application/jsonBody-Type:List of Chatmessage objectsExample Body:[{"time":1647281712369,"uuid":"6d34d7c6-a73a-4065-af94-60c977329c40","displayName":"FebanUHD","message":"Hello, this is a example message!!!"},{"time":123454678910,"uuid":"859c974c-2e32-4599-ac2e-05c7f06aead8","displayName":"ytendx","message":"Test"}]

We welcome every PR or Issue created and will look forward to review and implement them.But please bind to some rules:

• Please consider relying onjava conventions when opening a pr
• Please consider relying ongoogle java style guide too
• In general please consider having a good and readable code style
• We welcome if you document your code with comments andjava documentary