Docs
Getting Started
Please ensure all earnings from your project go to a project wallet address that is seperate from all other income streams or holdings. The project earnings should be isolated in it’s own address and not merged with any other value.
If your project is an NFT project, we highly advise following our guide on setting up NFT royalties for your contract, this will ensure sustained project income and encourage long term project development and growth from your contributors: NFT Royalties
▶️Invite our OpenProj bot to your server: Add To Discord
▶️Our bot will create the OpenProj category, the required channels and the OpenProjManager role
▶️The first message in a tasks-channel will define all the tasks that you are inviting members to complete.
▶️For a member to add and remove tasks they must have the OpenProjManager role of that server.
▶️Create tasks with the add_task slash command in your discord server:
/add_task
These commands must be used so that the “tasks” message is created by our bot, this is necessary as the bot will be updating the tasks message frequently and must be the author of the message to do so.
Title of the task
A number from 1 - 100 that describes the difficulty of the task and is also the amount shares a contributor will receive on completion of the task
Describe what the task entails
Specify how many threads can be created to contribute towards/complete a task
The bot will create links to the threads that members create Task Creator: The member that created this task
▶️Members can create a thread to attempt completion/contribution of a task
▶️The creator of this thread is held responsible for the task
▶️The thread creator may require other members to assist in contribution/completion of the task. The thread creator uses the split command to allocate a percentage of received shares to contributors in that thread.
▶️When the thread creator has judged that the task is sufficiently completed/contributed towards, they will use the split command in their thread, allocating shares to all assisting members for their contribution:
/split
▶️They will then archive the thread, awaiting evaluation.
▶️A member with the OpenprojManager role must set the percentage of shares the project owner will possess using the set_owner_shares_percent command, if contributors collectively accumulate 100 shares and the owner set their shares percent to 50%, the owner will have 100 shares as well. The owner will always have the percent of shares set with this command:
/set_owner_shares_percent▶️A member with the OpenprojManager role must use the set_owner_wallet_address command, their wallet earnings according to the amount set with the set_owner_shares_percent command will be released to this account:
/set_owner_wallet_address▶️Before the end of the month, members with the OpenProjManager role will evaluate all task contributions/completions of every task-channel and distribute the share amounts, they will distribute the shares as a percentage of the threads contribution towards completing the task and according to the thread creators’ split allocations:
/distribute
▶️On the first of every month your project's smart contract will update with the latest shareholders and their latest dividends, following this update you should convert the accumulated project funds to matic and send them to your projects smart contract address, the new funds are now releaseable to your contributors according to the latest share amounts
▶️Members must add their wallet address with the below command, members that fail to add their address will forfeit their earnings to everyone that did add their address:
/set_wallet_address▶️Like mee6 leveling up system, contributors can be rewarded a specified amount of shares every minute of communication on the channels you select
/enable_chat_shares/disable_chat_shares▶️requires owner input, therefore needs to be enabled
/enable_whitelist_task/disable_whitelist_task