https://github.com/voxel-fox-ltd/profile

A Discord bot for storing profiles, characters, and other user information in an easy and modular way.
https://github.com/voxel-fox-ltd/profile

discord discord-py

Last synced: 1 day ago
JSON representation

A Discord bot for storing profiles, characters, and other user information in an easy and modular way.

• Host: GitHub
• URL: https://github.com/voxel-fox-ltd/profile
• Owner: Voxel-Fox-Ltd
• License: gpl-2.0
• Created: 2019-07-09T02:07:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-19T23:31:36.000Z (6 months ago)
• Last Synced: 2024-08-20T03:42:38.648Z (6 months ago)
• Topics: discord, discord-py
• Language: Python
• Homepage:
• Size: 1.92 MB
• Stars: 17
• Watchers: 4
• Forks: 14
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Profile

Profile is a powerful Discord bot used to help handle storing user-filled forms

in your servers.

![A Discord embed showing information about a cat girl character.](https://voxelfox.co.uk/static/images/profile/dec-2022/profile-example-neko.png)

## What does it do?

With Profile, a server's moderators are able to create, modify, and manage

different forms for users to fill in. Systems like this are a great help to

a variety of communities - from storing character sheets in roleplay

servers, to storing your fantasy football team, to just making moderator

applications within your server.

Using Profile gives you automated flexibility - roles can be assigned to people

after profiles are verified. Profiles can automatically fill in values based

on current user roles. Don't worry about explicit language either; you can set

up Profile so that user profiles need to be verified by your moderator team

before they can go public.

## How do I use it?

There are two main parts to Profile - the moderator side (setting up and

managing templates) and the user side (filling in created templates in a

server).

### Managing templates

By default, these commands require the `manage guild` permission. You can

change this in your server's integrations settings, however.

* `/template create [name]`

    * This will create a new template that users can fill in.

* `/template edit [name]`

    * From this you can edit the attributes of the template - fields for the

    users to fill in, role to be assigned, locations where verification and

    archiving takes place, etc.

* `/template delete [name]`

    * This will permanently delete the referenced template, and all associated

    profiles.

* `/template list`

    * This will list the templates for your server.

### Managing profiles

Profiles are the user-facing side of Profile. Users can fill in the templates

that you have created.

For the purposes of this example, we're going to assume that your created

template has the name "character".

* `/character create`

    * This will set up a profile under the template for you.

* `/character get `

    * This will give you a list of your profiles in that template.

    * If you provide a user, it will give you a list of *their* profiles

    instead.

* `/character edit [name]`

    * This will let you edit one of your profiles.

* `/character delete [name]`

    * This will delete one of your profiles.

### Managing profiles for other people

Sometimes you may want to manage profiles for other people, forcibly editing or

deleting something for another user. There are commands in place to help with

that!

* `/template manage create [template] [user]`

* `/template manage edit [template] [user] [name]`

* `/template manage delete [template] [user] [name]`