Skip to content

Commit a7f554f

Browse files
committed
Added LICENSE and README
1 parent bd67c86 commit a7f554f

File tree

2 files changed

+168
-0
lines changed

2 files changed

+168
-0
lines changed

LICENSE.md

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# PolyForm Noncommercial License 1.0.0
2+
3+
<https://polyformproject.org/licenses/noncommercial/1.0.0>
4+
5+
## Acceptance
6+
7+
In order to get any license under these terms, you must agree
8+
to them as both strict obligations and conditions to all
9+
your licenses.
10+
11+
## Copyright License
12+
13+
The licensor grants you a copyright license for the
14+
software to do everything you might do with the software
15+
that would otherwise infringe the licensor's copyright
16+
in it for any permitted purpose. However, you may
17+
only distribute the software according to [Distribution
18+
License](#distribution-license) and make changes or new works
19+
based on the software according to [Changes and New Works
20+
License](#changes-and-new-works-license).
21+
22+
## Distribution License
23+
24+
The licensor grants you an additional copyright license
25+
to distribute copies of the software. Your license
26+
to distribute covers distributing the software with
27+
changes and new works permitted by [Changes and New Works
28+
License](#changes-and-new-works-license).
29+
30+
## Notices
31+
32+
You must ensure that anyone who gets a copy of any part of
33+
the software from you also gets a copy of these terms or the
34+
URL for them above, as well as copies of any plain-text lines
35+
beginning with `Required Notice:` that the licensor provided
36+
with the software. For example:
37+
38+
> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
39+
40+
## Changes and New Works License
41+
42+
The licensor grants you an additional copyright license to
43+
make changes and new works based on the software for any
44+
permitted purpose.
45+
46+
## Patent License
47+
48+
The licensor grants you a patent license for the software that
49+
covers patent claims the licensor can license, or becomes able
50+
to license, that you would infringe by using the software.
51+
52+
## Noncommercial Purposes
53+
54+
Any noncommercial purpose is a permitted purpose.
55+
56+
## Personal Uses
57+
58+
Personal use for research, experiment, and testing for
59+
the benefit of public knowledge, personal study, private
60+
entertainment, hobby projects, amateur pursuits, or religious
61+
observance, without any anticipated commercial application,
62+
is use for a permitted purpose.
63+
64+
## Noncommercial Organizations
65+
66+
Use by any charitable organization, educational institution,
67+
public research organization, public safety or health
68+
organization, environmental protection organization,
69+
or government institution is use for a permitted purpose
70+
regardless of the source of funding or obligations resulting
71+
from the funding.
72+
73+
## Fair Use
74+
75+
You may have "fair use" rights for the software under the
76+
law. These terms do not limit them.
77+
78+
## No Other Rights
79+
80+
These terms do not allow you to sublicense or transfer any of
81+
your licenses to anyone else, or prevent the licensor from
82+
granting licenses to anyone else. These terms do not imply
83+
any other licenses.
84+
85+
## Patent Defense
86+
87+
If you make any written claim that the software infringes or
88+
contributes to infringement of any patent, your patent license
89+
for the software granted under these terms ends immediately. If
90+
your company makes such a claim, your patent license ends
91+
immediately for work on behalf of your company.
92+
93+
## Violations
94+
95+
The first time you are notified in writing that you have
96+
violated any of these terms, or done anything with the software
97+
not covered by your licenses, your licenses can nonetheless
98+
continue if you come into full compliance with these terms,
99+
and take practical steps to correct past violations, within
100+
32 days of receiving notice. Otherwise, all your licenses
101+
end immediately.
102+
103+
## No Liability
104+
105+
***As far as the law allows, the software comes as is, without
106+
any warranty or condition, and the licensor will not be liable
107+
to you for any damages arising out of these terms or the use
108+
or nature of the software, under any kind of legal claim.***
109+
110+
## Definitions
111+
112+
The **licensor** is the individual or entity offering these
113+
terms, and the **software** is the software the licensor makes
114+
available under these terms.
115+
116+
**You** refers to the individual or entity agreeing to these
117+
terms.
118+
119+
**Your company** is any legal entity, sole proprietorship,
120+
or other kind of organization that you work for, plus all
121+
organizations that have control over, are under the control of,
122+
or are under common control with that organization. **Control**
123+
means ownership of substantially all the assets of an entity,
124+
or the power to direct its management and policies by vote,
125+
contract, or otherwise. Control can be direct or indirect.
126+
127+
**Your licenses** are all the licenses granted to you for the
128+
software under these terms.
129+
130+
**Use** means anything you do with the software requiring one
131+
of your licenses.

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Sentinel
2+
3+
**Sentinel** is a Velocity plugin that securely links Minecraft accounts to Discord accounts. It integrates with a Discord bot to verify players before allowing login, helping to prevent impersonation and aiding in connecting players together.
4+
5+
## Commands
6+
/link <code>
7+
Link your Minecraft account to your Discord account.
8+
9+
/whois [discord: @user | minecraft: username]
10+
Look up linked account info.
11+
12+
## Requirements
13+
14+
- Java 17+
15+
- Velocity Proxy (tested on 3.4.0-SNAPSHOT)
16+
- MySQL or MariaDB
17+
18+
## Setup
19+
20+
1. **Install the plugin**
21+
Place the shaded JAR into your `plugins/` folder on your Velocity proxy.
22+
23+
2. **Configure MySQL**
24+
On first run, `plugins/sentinel/config.json` will be created. Fill in your database credentials and Discord token:
25+
```json
26+
{
27+
"mysql": {
28+
"host": "localhost",
29+
"port": 3306,
30+
"database": "sentinel",
31+
"username": "sentinel_user",
32+
"password": "password"
33+
},
34+
"discord_token": "your_discord_bot_token"
35+
}
36+
```
37+

0 commit comments

Comments
 (0)