BeeStation / BeeStation-Hornet

99.95% station. 0.05% bees
https://beestation13.com
GNU Affero General Public License v3.0
200 stars 682 forks source link

Adds In-game Player Report Template (configurable template) #11880

Open EvilDragonfiend opened 1 week ago

EvilDragonfiend commented 1 week ago

About The Pull Request

Adds In-game Player Report Template

Why It's Good For The Game

Players sometimes face tedious times to write basic stuff like date, round number, sort of it. This helps them to feel less tedious.

Testing Photographs and Procedure

image

https://forums.beestation13.com/t/testing-ingame-report-template-system/26385

Copypasta result

forgot to deadmin atm, but it works well without admin rank.

NOTE: unknown round number is because it was ran in my local. It will work in in live servers with actual round IDs

Changelog

:cl: config: "Admin" tab now has "Copy In-game Report Template". You can copy ingame information for player report. To use this, enable 'USE_PLAYER_REPORT_TEMPLATE' in the config file, and change the template file 'player_report_template.txt' as how you want. /:cl:

BriggsIDP commented 1 week ago

Great PR. This would be great for bug reports too. Many users vocally don't report bugs because they require a git hub account. if it where possible to have a bug reported in game posted to the codebase under a bot with the users name I think we would have a lot more reports; this would probably need crossed perm though

EvilDragonfiend commented 1 week ago

Great PR. This would be great for bug reports too. Many users vocally don't report bugs because they require a git hub account. if it where possible to have a bug reported in game posted to the codebase under a bot with the users name I think we would have a lot more reports; this would probably need crossed perm though

yep, but likely once this is found to be working well.

EvilDragonfiend commented 1 week ago

I don't think it is necessarily healthy to have this in the game.

I am not sure what is 'necessarily healthy'

Also if anything either do it in tgui instead of plain html or just open forum (where the template is added by default to posts)

PowerfulBacon commented 1 week ago
  1. This needs to be config
  2. Is this actually all that useful? It doesn't fill out a lot of information and people should never be making reports without making an ahelp first to get it solved immediately.

Rather than being a verb, if this is to exists then it should be a message in chat when you create an ahelp. When clicking the link it should open the reports website in a new browser and copy the report into the clipboard, including the original ahelp message.

EvilDragonfiend commented 1 week ago
  1. This needs to be config

sure but I won't make the format configurable. I don't want to put much effort right now. config option will only show the verb to people

  1. Is this actually all that useful? It doesn't fill out a lot of information and people should never be making reports without making an ahelp first to get it solved immediately.

You'll be surprised even writing such basic stuff is how tedious it is. That's why people put the thumb up tags there a lot.

Rather than being a verb, if this is to exists then it should be a message in chat when you create an ahelp. When clicking the link it should open the reports website in a new browser and copy the report into the clipboard, including the original ahelp message.

I don't think it is possible to do "copy the desired contents to clipboard when you click it on a chat button" in this byond system because of cursed IE11(not real). The thing in my PR is done with a cheating way but it's not feasible in chat system.

EvilDragonfiend commented 5 days ago

Template is now configurable. Check player_report_template.txt in config directory.

// check 'get_ingame_report.dm' for the detail. Enable 'USE_PLAYER_REPORT_TEMPLATE' config if you want to use this. (Also this first is not copied)
# In-game report: (by In-game template)

&lt!-- [READ ME] Title should be: [Offender's CKEY] Player Report --&gt

CKEY: %CKEY%

Your Character Name: %MOB_NAME%

Your Discord:

Offender's CKEY:

Offender's In-Game Name:

Date (YYYY-MM-DD): (UST) %DATE% (template copied)

Round Number: %ROUND_ID% (%SERVER_NAME%)

Rules Broken:

Incident Description:

Additional Information:

This is our template

// check 'get_ingame_report.dm' for the detail. Enable 'USE_PLAYER_REPORT_TEMPLATE' config if you want to use this. (Also this first is not copied)
**Your ckey:** %CKEY%

**Your IC Name:** %MOB_NAME%

**Your Discord ID:**

**Date of round:** %DATE% (template copied)

**Round ID:** %ROUND_ID% (%SERVER_NAME%)

**Defendant’s IC Name:** 

**Defendant’s ckey:**

**Complaint:**

This is NSV template (as sample)