Croc/croccybot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' into rewrite

Browse Source
This commit is contained in:
Conatum
2023-10-29 04:00:51 +02:00
parent ec0463f0e7 d77f164aac
commit d3a14cb9ea
2 changed files with 52 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
LICENSE.md
View File

@@ -1,10 +1,45 @@
Copyright (c) 2022, Ari Horesh. StudyLion Open Source License
All rights reserved.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR Copyright (c) 2023, Ari Horesh. All rights reserved.
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE ### 1. Definitions
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - "Software": Refers to the Discord bot named "StudyLion" and associated documentation, source code, scripts, assets, and other related materials.
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - "Educational Use": Means utilization of the Software primarily for learning, teaching, training, research, or development.
SOFTWARE. - "Non-commercial Use": Describes an application of the Software where there's no expectation or realization of direct or indirect monetary compensation.
### 2. Grant of License
- Under the terms and conditions of this license, the licensor grants a worldwide, non-exclusive, royalty-free, non-transferable license to:
- Use the Software.
- Reproduce the Software.
- Modify the Software, creating derivative works based on the Software.
- Distribute the unmodified Software for Educational and Non-commercial Use.
### 3. Restrictions
- Redistribution, whether modified or unmodified, must:
- Preserve the above copyright notice.
- Incorporate this list of conditions.
- Include the following disclaimers.
- You must not:
- Use the name, trademarks, service marks, or names of the Software or its contributors to endorse or promote derivative products without prior written consent.
- Deploy the Software or any derivative works thereof for commercial purposes or any context leading to financial gain.
- Assert proprietary rights or assign authorship of the original Software to any entity other than the original authors.
- Grant sublicenses for the Software.
### 4. Contributions
- Any contributions made to the Software by third parties shall be subject to this license. The contributor grants the licensor a non-exclusive, perpetual, irrevocable license to any such contributions.
### 5. Termination
- If you breach any terms of this license, your rights will terminate automatically. Once terminated, you must:
- Halt all utilization of the Software.
- Destroy or delete all copies of the Software in your possession or control.
### 6. Disclaimer and Limitation of Liability
- THE SOFTWARE IS OFFERED "AS IS", WITHOUT ANY GUARANTEES OR CLAIMS OF EFFICACY. NO WARRANTIES, IMPLIED OR EXPLICIT, ARE PROVIDED. THIS INCLUDES, BUT IS NOT RESTRICTED TO, WARRANTIES OF MERCHANDISE, FITNESS FOR A SPECIFIC PURPOSE, AND NON-INFRINGEMENT.
- UNDER NO CONDITION SHALL THE AUTHORS, COPYRIGHT HOLDERS, OR CONTRIBUTORS BE ACCOUNTABLE FOR ANY CLAIMS, DAMAGES, OR OTHER LIABILITIES, WHETHER RESULTING FROM CONTRACT, TORT, NEGLIGENCE, OR ANY OTHER LEGAL THEORY, EMERGING FROM, OUT OF, OR CONNECTED WITH THE SOFTWARE OR ITS USE.

20
README.md
View File

@@ -1,13 +1,13 @@
## StudyLion - Discord Study & Productivity Bot ## LionBot (formerly StudyLion) - Discord Study & Productivity Bot
StudyLion is a Discord bot that tracks members' study and work time while offering members the ability to view their statistics and use productivity tools such as: To-do lists, pomodoro timers, reminders, and much more. LionBot is a Discord bot that tracks members' study and work time while offering members the ability to view their statistics and use productivity tools such as: To-do lists, pomodoro timers, reminders, and much more.
[**Invite StudyLion here**](https://discord.studylions.com/invite "here"), and get started with `!help`. [**Invite LionBot here**](https://discord.com/oauth2/authorize?client_id=889078613817831495&permissions=8&scope=bot), and get started with `/help`.
Join the [**support server**](https://discord.gg/studylions "support server") to contact us if you need help configuring the bot on your server, or start a [**discussion**](https://github.com/StudyLions/StudyLion/discussions "disscussion") to report issues and bugs. Join the [**support server**](https://discord.gg/the-study-lions-780195610154237993) to contact us if you need help configuring the bot on your server, or start a [**discussion**](https://github.com/LionBots/LionBot/discussions "disscussion") to report issues and bugs.
@@ -18,14 +18,11 @@ In the past couple of years, we noticed a new trend on Discord – instead of be
This bot was founder by [Ari Horesh](https://www.youtube.com/arihoresh) (Ari Horesh#0001) to support these forming study communities and allow students all over the world to study better. This bot was founder by [Ari Horesh](https://www.youtube.com/arihoresh) (@AriHoresh) to support these forming study communities and allow students all over the world to study better.
### Self Hosting ### Self Hosting
We offer private instances based on availablity (a private bot for your community) to server owners who want their own branding (logo, color scheme, private and seperate database, better response-rate, and customizability to the text itself). You can self-host and fork the bot using the following steps, but beware that we do not provide support for self-hosted instances. If you are interested in a privately managed instance (affordable paid service), contact Ari at contact@arihoresh.com
If you are intrested, contact the founder at contact@arihoresh.com .
You can self-host and fork the bot using the following steps, but beware that this version **does not include** our visual graphical user interface, which is only include in the custom private instances or our the public instance.
Follow the steps below to self-host the bot. Follow the steps below to self-host the bot.
- Clone the repo recursively (which makes sure to include the cmdClient submodule, otherwise you need to initialise it separately) - Clone the repo recursively (which makes sure to include the cmdClient submodule, otherwise you need to initialise it separately)
@@ -38,7 +35,6 @@ We do not offer support for self-hosted bots, the code is provided as is without
## Features ## Features
- **Students Cards and Statistics** - **Students Cards and Statistics**
Allow users to create their own private student profile cards and set customs study field tags by using `!stats` and `!setprofile` Allow users to create their own private student profile cards and set customs study field tags by using `!stats` and `!setprofile`
@@ -108,8 +104,8 @@ Punish cheaters, audit-log, welcome message, and so much more using our full-sca
### Tutorials ### Tutorials
A command list and general documentation for StudyLion may be found using the `!help` command, and documentation for a specific command, e.g. `config`, may be found with `!help config`. A command list and general documentation for LionBot may be found using the `!help` command, and documentation for a specific command, e.g. `config`, may be found with `!help config`.
Make sure to check the [full documentation](https://www.notion.so/izabellakis/StudyLion-Bot-Tutorials-f493268fcd12436c9674afef2e151707 "StudyLion Tutorial") to stay updated. Make sure to check the [full documentation](https://www.notion.so/izabellakis/LionBot-Bot-Tutorials-f493268fcd12436c9674afef2e151707 "LionBot Tutorial") to stay updated.
<a href="https://imgur.com/ziPdJGw"><img src="https://i.imgur.com/ziPdJGws.png" title="source: imgur.com" /></a> <a href="https://imgur.com/ziPdJGw"><img src="https://i.imgur.com/ziPdJGws.png" title="source: imgur.com" /></a>