Sovereignty/error-popper
1
0
Fork 0
generated from Sovereignty/rojo-selene-luau-template
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md to include short introduction and method information

Browse source
This commit is contained in:
Sovereignty 2025-04-26 16:17:17 +00:00
parent 039b5f49a7
commit 5613178cca
1 changed files with 7 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
README.md
View file

@ -1,49 +1,9 @@
# Template Repository
Meant to be used as a template when creating new repositories.
# Error Popper
This is a small library meant to handle the tracking of all errors on the server, subsequently sending them as formatted discord webhook messages.
It offers a few helper methods to specify which webhook URL, which will be converted into a proxy mask, as well as any custom fields you would like.
The default project json is a little advanced for some individuals' tastes. You are welcome to switch it out, or use one of the other provided project template files.
## Uses
# CustomFields
The add chainable method allows you to specify custom fields, the value of which can either be a static value or a function which will be called upon each error being prepared for messaging.
- Selene for linting
- Rojo for syncing
- Luau Language Server for syntax, intellisense, type checking, and intellisense syncing
## How To Use
Go ahead and create a new repository by selecting the plus icon on the top right of the screen.
![Select the plus icon in the top right corner of your screen](assets/image-1.png)
A dropdown menu will open, pick the first option.
![Select New repository](assets/image-2.png)
When creating a new repository, you will be prompted with the chance to choose the template for your new repo.
Select this repository, and then select the options shown below.
![Git content, Webhooks, Topics, Issue Labels, and Branch protection were selected underneath the chosen template repo](assets/image.png)
## Installation
- Luau Language Server [Link](https://marketplace.visualstudio.com/items?itemName=JohnnyMorganz.luau-lsp)
- Has an optional Roblox Studio plugin which allows for you to have intellisense for in-studio assets like Instances.
- Rojo (One way syncing) [Link](https://marketplace.visualstudio.com/items?itemName=evaera.vscode-rojo)
- You will need the Roblox Studio pair version of this extension.
- Selene Linting (Preferably download locally via cargo{rust}) [Link](https://marketplace.visualstudio.com/items?itemName=Kampfkarren.selene-vscode)
- Stylua (Styling/Formatting) [Link](https://marketplace.visualstudio.com/items?itemName=JohnnyMorganz.stylua)
## Info
Use the init.meta.json to ignore descendant/neighbor files when syncing. This means that it will not overwrite non rojo files that may be present only in Roblox Studio.
Clone this file into whatever folder this functionality would be applicable to you.
## Branches
The repository has two protected branches.
- main
- Does not allow for code to be pushed to main, and merging a branch into main requires approval before doing so.
- testing
- Does not allow for code to be pushed to testing, however merging is permitted as this branch is intended for testing code.
# Example
You can find an example file inside of src/ServerScripts/Example.server.lua for how to use the library.