generated from nhcarrigan/template
feat: remove project documentation
This commit is contained in:
parent
d5a860a19b
commit
4ce6062cb3
SSH Key Fingerprint:
SHA256:rca1iUI2OhAM6n4FIUaFcZcicmri0jgocqKiTTAfrt8
@ -15,18 +15,6 @@
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Projects**
|
|
||||||
|
|
||||||
- [Art for Palestine Bot](/projects/art-for-palestine-bot/index)
|
|
||||||
- [Self Hosting](/projects/art-for-palestine-bot/self-hosting)
|
|
||||||
- [Discord Verification Bot](/projects/discord-verification-bot/index)
|
|
||||||
- [Usage](/projects/discord-verification-bot/usage)
|
|
||||||
- [We Love Hacktoberfest](/projects/we-love-hacktoberfest/index)
|
|
||||||
- [Contributing](/projects/we-love-hacktoberfest/contributing)
|
|
||||||
- [Self Hosting](/projects/we-love-hacktoberfest/self-hosting)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Community**
|
**Community**
|
||||||
|
|
||||||
- [Code of Conduct](/coc)
|
- [Code of Conduct](/coc)
|
||||||
|
|||||||
@ -1,5 +0,0 @@
|
|||||||
# Art for Palestine Bot
|
|
||||||
|
|
||||||
This is a bot that was specifically written for the Art for Palestine charity event.
|
|
||||||
|
|
||||||
[View the Code](https://codeberg.org/nhcarrigan/a4p-bot) | [View the Live App](https://discord.gg/kHNyb6Vyf8)
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
# Self Hosting
|
|
||||||
|
|
||||||
Instructions coming soon!
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
# Discord Verification Bot
|
|
||||||
|
|
||||||
This bot is designed as a basic verification gate for your Discord server.
|
|
||||||
|
|
||||||
[View the Code](https://codeberg.org/nhcarrigan/verification-bot) | [Invite the Bot](https://discord.com/api/oauth2/authorize?client_id=880171019409694742&permissions=268454914&scope=bot%20applications.commands)
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
# Usage
|
|
||||||
|
|
||||||
The bot is designed to work with the following flow:
|
|
||||||
|
|
||||||
- New members who join your server can only see a "verification" channel (one that is not visible to anyone else).
|
|
||||||
- Within that channel, you should run the `/start` command to set up your verification question, answers, and the role to assign. The bot will create a post explaining the process to new members, with a button to click to verify themselves.
|
|
||||||
- Upon clicking the button, the member will be asked to answer the question. If they answer incorrectly, they are kicked. If they answer correctly, they are given the verification role.
|
|
||||||
- If they do not verify in 30 minutes, they are kicked.
|
|
||||||
|
|
||||||
Ideally, you should configure the verification role such that members **with** that role cannot see the verification channel.
|
|
||||||
@ -1,31 +0,0 @@
|
|||||||
# Contributing
|
|
||||||
|
|
||||||
In addition to our standard contribution guidelines, there are some extra notes for this project.
|
|
||||||
|
|
||||||
## Adding Tags
|
|
||||||
|
|
||||||
Tags are used to respond to frequently asked questions. New tags can be added to `/src/data/tags`, and should be added in alphabetical order by
|
|
||||||
`name`.
|
|
||||||
|
|
||||||
Tags require the following properties:
|
|
||||||
|
|
||||||
- `name`: The name of the tag. This is used to trigger the tag with `hf.<name>`.
|
|
||||||
- `content`: This is the main body of the tag. You can insert line breaks with `\n`.
|
|
||||||
- `title`: This is the title of the tag, which **should take the form of a question**.
|
|
||||||
- `aliases`: These serve as alternate names for triggering the tag.
|
|
||||||
|
|
||||||
## Adding Phrases to the Bot
|
|
||||||
|
|
||||||
To add new responses to the bot, navigate to the `src/data/phrases.ts` file. Within the array, add the phrases you'd like the bot to potentially respond with.
|
|
||||||
|
|
||||||
## Adding Hearts to the Bot
|
|
||||||
|
|
||||||
All of our hearts are generously provided by [Luke's DevHearts project](https://github.com/lukeocodes/dev-hearts). Before you add a heart to this project, you need to submit it there and have it approved. Be sure to follow their contributing guidelines!
|
|
||||||
|
|
||||||
Once your heart is approved and merged, add the _name_ of your new heart file to the `src/data/hearts.ts` file - do _not_ include the file extension.
|
|
||||||
|
|
||||||
## Adding new users
|
|
||||||
|
|
||||||
To add a new user to respond to, navigate to the `src/data/loveData.ts` file. Create a new object with the corresponding data - if you are adding a corporate sponsor, exclude the `id` field.
|
|
||||||
|
|
||||||
Then, add a new array with the user's phrases in `src/data/phrases.ts`.
|
|
||||||
@ -1,5 +0,0 @@
|
|||||||
# We Love Hacktoberfest
|
|
||||||
|
|
||||||
This is a Discord bot built for the Hacktoberfest server. Originally intended to spread positivity for the stressed Hacktoberfest team in 2020, the bot has since been expanded to include a tag system for frequently asked questions.
|
|
||||||
|
|
||||||
[View the Code](https://codeberg.org/nhcarrigan/hacktoberfest) | [View the Live App](https://discord.gg/hacktoberfest)
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
# Self Hosting
|
|
||||||
|
|
||||||
Instructions coming soon!
|
|
||||||
Loading…
x
Reference in New Issue
Block a user