A collection of in-game forms that allow players to submit data to a remote web server.
This addon lets players fill data in pre-made forms that can then be sent to a remote web server to be processed.
The addon will look for a url stored in the file cfc/contact/url.txt
stored in the server's DATA
folder.
Upon sending data to the web server, an endpoint will be added to the URL specified.
The URL is formatted as such: <url>/<endpoint>
e.g. http://localhost:3000/contact-forms/bug-report
The addon also requires a file cfc/realm.txt
in the DATA
folder that contains the name of the server.
This is useful for differentiating multiple servers. The realm is included with the data sent to the web server.
The contact form allows players to send a contact method for you to get in touch with them as well as a message of what they would like to talk about.
Endpoint | Data |
---|---|
contact |
steam_id The steam id of the player that sent the formsteam_name The steam name of the player that sent the formcontact_method The prefered contact method of the playermessage The message from the playerrealm The realm of the server |
The feedback form allows players to give feedback on the server as well as a rating out of 5 and whether they would come back or not.
Endpoint | Data |
---|---|
feedback |
steam_id The steam id of the player that sent the formsteam_name The steam name of the player that sent the formrating The rating out of 5likely_to_return Whether the player would return or notmessage The player's feedbackrealm The realm of the server |
The bug report form allows players to report a bug they found on the server as well as it's urgency.
Endpoint | Data |
---|---|
bug-report |
steam_id The steam id of the player that sent the formsteam_name The steam name of the player that sent the formurgency The urgency of the bugmessage A description of the bugrealm The realm of the server |
The freeze report form allows player to report freezing on the server with the severity, a description and debug information collected from the server.
Endpoint | Data |
---|---|
freeze-report |
steam_id The steam id of the player that sent the formsteam_name The steam name of the player that sent the formdebug_information A table containing information about the serverseverity The severity of the freezingmessage A description of the situationrealm The realm of the server |
The debug information table contains:
counts
: A table of player steam ids as keys with their value being the entity count of that player. (World entities are owned byworld
)E2Info
: A list of all Expression 2 containing their namename
, code size in characterssize
and owner steam idowner
(world
if the owner is invalid ).playerInfo
: A table of player steam ids as keys with a table as value containing the player namename
, that player's position in the mappos
, the player's pingping
and their packet losspacketloss
.serverInfo
: A table containing the server's uptimeuptime
and tick rateticktime
.
The player report form allows players to report a player that is breaking the rules giving the urgency and a description of the situation.
Endpoint | Data |
---|---|
player-report |
steam_id The steam id of the player that sent the formsteam_name The steam name of the player that sent the formreported_steam_id The steam id of the reported playerreported_steam_name The steam name of the reported playerurgency The urgency of the situationmessage A description of the situationrealm The realm of the server |
The staff report form allows players to report a staff member that is breaking the rules anonymously giving the urgency and a description of the situation.
Endpoint | Data |
---|---|
staff-report |
reported_steam_id The steam id of the reported playerreported_steam_name The steam name of the reported playerurgency The urgency of the situationmessage A description of the situationrealm The realm of the server |
The staff report form uses preset ranks and must be changed in the Client file