Skip to content

Commit 1f3bd0e

Browse files
authored
Update changelog and updated all the links to new repo (#3251)
1 parent 8d41c1d commit 1f3bd0e

12 files changed

+166
-158
lines changed

.github/CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ Pull requests are the best way to propose changes to the codebase. We actively w
3030
## Any contributions you make will be under the GNU Affero General Public License v3.0
3131
In short, when you submit code changes, your submissions are understood to be under the same [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html) that covers the project. Feel free to contact the maintainers if that's a concern.
3232

33-
## Report bugs using [Github Issues](https://github.com/kyb3r/modmail/issues)
34-
We use GitHub issues to track public bugs. Report a bug by [opening a new Issue](https://github.com/kyb3r/modmail/issues/new); it's that easy!
33+
## Report bugs using [Github Issues](https://github.com/modmail-dev/modmail/issues)
34+
We use GitHub issues to track public bugs. Report a bug by [opening a new Issue](https://github.com/modmail-dev/modmail/issues/new); it's that easy!
3535

3636
## Find pre-existing issues to tackle
37-
Check out our [unstaged issue tracker](https://github.com/kyb3r/modmail/issues?q=is%3Aissue+is%3Aopen+-label%3Astaged) and start helping out!
37+
Check out our [unstaged issue tracker](https://github.com/modmail-dev/modmail/issues?q=is%3Aissue+is%3Aopen+-label%3Astaged) and start helping out!
3838

3939
Ways to help out:
4040
- Help out new members

.github/pull.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
version: "1"
22
rules:
33
- base: master
4-
upstream: kyb3r:master
4+
upstream: modmail-dev:master
55
mergeMethod: hardreset
66
- base: development
7-
upstream: kyb3r:development
7+
upstream: modmail-dev:development
88
mergeMethod: hardreset

CHANGELOG.md

+122-114
Large diffs are not rendered by default.

README.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@
1111

1212
<br>
1313

14-
<a href="https://heroku.com/deploy?template=https://github.com/kyb3r/modmail">
14+
<a href="https://heroku.com/deploy?template=https://github.com/modmail-dev/modmail">
1515
<img src="https://img.shields.io/badge/deploy_to-heroku-997FBC.svg?style=for-the-badge&logo=Heroku">
1616
</a>
1717

18-
<a href="https://github.com/kyb3r/modmail/">
18+
<a href="https://github.com/modmail-dev/modmail/">
1919
<img src="https://api.modmail.dev/badges/instances.svg" alt="Bot instances">
2020
</a>
2121

22-
<a href="https://discord.gg/j5e9p8w">
23-
<img src="https://img.shields.io/discord/515071617815019520.svg?label=Discord&logo=Discord&colorB=7289da&style=for-the-badge" alt="Support">
22+
<a href="https://discord.gg/cnUpwrnpYb">
23+
<img src="https://img.shields.io/discord/1079074933008781362.svg?label=Discord&logo=Discord&colorB=7289da&style=for-the-badge" alt="Support">
2424
</a>
2525

2626
<a href="https://patreon.com/kyber">
@@ -35,7 +35,7 @@
3535
<img src="https://img.shields.io/badge/Code%20Style-Black-black?style=for-the-badge">
3636
</a>
3737

38-
<a href="https://github.com/kyb3r/modmail/blob/master/LICENSE">
38+
<a href="https://github.com/modmail-dev/modmail/blob/master/LICENSE">
3939
<img src="https://img.shields.io/badge/license-agpl-e74c3c.svg?style=for-the-badge" alt="MIT License">
4040
</a>
4141

@@ -96,23 +96,23 @@ There are a few options for hosting your very own dedicated Modmail bot.
9696

9797
### Patreon Hosting
9898

99-
If you don't want the trouble of renting and configuring your server to host Modmail, we got a solution for you! We offer hosting and maintenance of your own, private Modmail bot (including a Logviewer) through [**Patreon**](https://patreon.com/kyber). Join our [Modmail Discord Server](https://discord.gg/etJNHCQ) for more info!
99+
If you don't want the trouble of renting and configuring your server to host Modmail, we got a solution for you! We offer hosting and maintenance of your own, private Modmail bot (including a Logviewer) through [**Patreon**](https://patreon.com/kyber). Join our [Modmail Discord Server](https://discord.gg/cnUpwrnpYb) for more info!
100100

101101
### Local hosting (General Guide)
102102

103-
Modmail can be hosted on any modern hardware, including your PC. For stability and reliability, we suggest purchasing a cloud server (VPS) for under $10/mo. If you need recommendations on choosing a VPS, join our [Discord server](https://discord.gg/j5e9p8w), and we'll send you a list of non-affiliated hosting providers. Alternatively, we can host Modmail for you when you're subscribed to our [Patreon](https://patreon.com/kyber).
103+
Modmail can be hosted on any modern hardware, including your PC. For stability and reliability, we suggest purchasing a cloud server (VPS) for under $10/mo. If you need recommendations on choosing a VPS, join our [Discord server](https://discord.gg/cnUpwrnpYb), and we'll send you a list of non-affiliated hosting providers. Alternatively, we can host Modmail for you when you're subscribed to our [Patreon](https://patreon.com/kyber).
104104

105105
This guide assumes you've downloaded [`Python 3.10`](https://www.python.org/downloads/release/python-376/) and added python and pip to PATH.
106106

107107
1. Clone this repo
108108
```console
109-
$ git clone https://github.com/kyb3r/modmail
109+
$ git clone https://github.com/modmail-dev/modmail
110110
$ cd modmail
111111
```
112-
2. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/kyb3r/modmail/wiki/Installation#2-discord-bot-account))
113-
3. Create a free MongoDB database ([guide](https://github.com/kyb3r/modmail/wiki/Installation-(cont.)#3-create-a-database), follow it carefully!)
112+
2. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/modmail-dev/modmail/wiki/Installation#2-discord-bot-account))
113+
3. Create a free MongoDB database ([guide](https://github.com/modmail-dev/modmail/wiki/Installation-(cont.)#3-create-a-database), follow it carefully!)
114114
4. Rename the file `.env.example` to `.env` and fill it with appropriate values
115-
- If you can't find `.env.example` because it's hidden, create a new text file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/kyb3r/modmail/master/.env.example) and replace the placeholders with their values
115+
- If you can't find `.env.example` because it's hidden, create a new text file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/modmail-dev/modmail/master/.env.example) and replace the placeholders with their values
116116
- If you're on Windows and cannot save the file as `.env`, save it as `.env.` instead (this only applies to Windows!)
117117
- If you do not have a Logviewer yet, leave the `LOG_URL` field as-is
118118
5. Update pip, install pipenv, and install dependencies using pipenv
@@ -125,16 +125,16 @@ This guide assumes you've downloaded [`Python 3.10`](https://www.python.org/down
125125
```console
126126
$ pipenv run bot
127127
```
128-
7. Set up the Logviewer, see the [Logviewer installation guide](https://github.com/kyb3r/logviewer)
128+
7. Set up the Logviewer, see the [Logviewer installation guide](https://github.com/modmail-dev/logviewer)
129129

130130
### Local Hosting (Docker)
131131

132132
We provide support for Docker to simplify the deployment of Modmail and Logviewer.
133133
We assume you already have Docker and Docker Compose Plugin installed, if not, see [here](https://docs.docker.com/get-docker/).
134134

135-
1. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/kyb3r/modmail/wiki/Installation#2-discord-bot-account))
136-
2. Create a file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/kyb3r/modmail/master/.env.example) and replace the placeholders with their values
137-
3. Create a file named `docker-compose.yml`, then copy the contents of [this file](https://raw.githubusercontent.com/kyb3r/modmail/master/docker-compose.yml), do not change anything!
135+
1. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/modmail-dev/modmail/wiki/Installation#2-discord-bot-account))
136+
2. Create a file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/modmail-dev/modmail/master/.env.example) and replace the placeholders with their values
137+
3. Create a file named `docker-compose.yml`, then copy the contents of [this file](https://raw.githubusercontent.com/modmail-dev/modmail/master/docker-compose.yml), do not change anything!
138138
4. Start the bot
139139
```console
140140
$ docker compose up -d
@@ -147,22 +147,22 @@ Our Docker images are hosted on [GitHub Container Registry](ghcr.io), you can bu
147147
$ docker build --tag=modmail:master .
148148
```
149149

150-
Then simply remove `ghcr.io/kyb3r/` from the `docker-compose.yml` file.
150+
Then simply remove `ghcr.io/modmail-dev/` from the `docker-compose.yml` file.
151151

152152
### Local Hosting (OS-Specific)
153153

154-
This guide is a WIP. Join our [Discord server](https://discord.gg/j5e9p8w) for more info.
154+
This guide is a WIP. Join our [Discord server](https://discord.gg/cnUpwrnpYb) for more info.
155155

156156
### Platform as a Service (PaaS)
157157

158158
You can host this bot on Heroku (no longer free).
159159

160160
Installation via Heroku is possible with your web browser alone.
161-
The [**installation guide**](https://github.com/kyb3r/modmail/wiki/Installation) (which includes a video tutorial!) will guide you through the entire installation process. If you run into any problems, join our [Modmail Discord Server](https://discord.gg/etJNHCQ) for help and support.
161+
The [**installation guide**](https://github.com/modmail-dev/modmail/wiki/Installation) (which includes a video tutorial!) will guide you through the entire installation process. If you run into any problems, join our [Modmail Discord Server](https://discord.gg/cnUpwrnpYb) for help and support.
162162

163163
When using Heroku, you can configure automatic updates:
164164
- Login to [GitHub](https://github.com/) and verify your account.
165-
- [Fork the repo](https://github.com/kyb3r/modmail/fork).
165+
- [Fork the repo](https://github.com/modmail-dev/modmail/fork).
166166
- Install the [Pull app](https://github.com/apps/pull) for your fork.
167167
- Then go to the Deploy tab in your [Heroku account](https://dashboard.heroku.com/apps) of your bot app, select GitHub and connect your fork (usually by typing "Modmail").
168168
- Turn on auto-deploy for the `master` branch.
@@ -213,20 +213,20 @@ Become a sponsor on [Patreon](https://patreon.com/kyber).
213213
Modmail supports the use of third-party plugins to extend or add functionalities to the bot.
214214
Plugins allow niche features as well as anything else outside of the scope of the core functionality of Modmail.
215215

216-
You can find a list of third-party plugins using the `?plugins registry` command or visit the [Unofficial List of Plugins](https://github.com/kyb3r/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins contributed by the community.
216+
You can find a list of third-party plugins using the `?plugins registry` command or visit the [Unofficial List of Plugins](https://github.com/modmail-dev/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins contributed by the community.
217217

218-
To develop your own, check out the [plugins documentation](https://github.com/kyb3r/modmail/wiki/Plugins).
218+
To develop your own, check out the [plugins documentation](https://github.com/modmail-dev/modmail/wiki/Plugins).
219219

220-
Plugins requests and support are available in our [Modmail Support Server](https://discord.gg/j5e9p8w).
220+
Plugins requests and support are available in our [Modmail Support Server](https://discord.gg/cnUpwrnpYb).
221221

222222
## Contributing
223223

224-
Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our [contributing guidelines](https://github.com/kyb3r/modmail/blob/master/.github/CONTRIBUTING.md) before you get started.
224+
Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our [contributing guidelines](https://github.com/modmail-dev/modmail/blob/master/.github/CONTRIBUTING.md) before you get started.
225225

226226
If you like this project and would like to show your appreciation, support us on **[Patreon](https://www.patreon.com/kyber)**!
227227

228228
## Beta Testing
229229

230-
Our [development](https://github.com/kyb3r/modmail/tree/development) branch is where most of our features are tested before public release. Be warned that there could be bugs in various commands so keep it away from any large servers you manage.
230+
Our [development](https://github.com/modmail-dev/modmail/tree/development) branch is where most of our features are tested before public release. Be warned that there could be bugs in various commands so keep it away from any large servers you manage.
231231

232232
If you wish to test the new features and play around with them, feel free to join our [Public Test Server](https://discord.gg/v5hTjKC). Bugs can be raised within that server or in our Github issues (state that you are using the development branch though).

app.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "Modmail",
33
"description": "An easy to install Modmail bot for Discord - DM to contact mods!",
4-
"repository": "https://github.com/kyb3r/modmail",
4+
"repository": "https://github.com/modmail-dev/modmail",
55
"env": {
66
"TOKEN": {
77
"description": "Your discord bot's token.",

cogs/modmail.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ async def setup(self, ctx):
9494
embed.add_field(
9595
name="Thanks for using our bot!",
9696
value="If you like what you see, consider giving the "
97-
"[repo a star](https://github.com/kyb3r/modmail) :star: and if you are "
97+
"[repo a star](https://github.com/modmail-dev/modmail) :star: and if you are "
9898
"feeling extra generous, buy us coffee on [Patreon](https://patreon.com/kyber) :heart:!",
9999
)
100100

cogs/plugins.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ class Plugins(commands.Cog):
114114
These addons could have a range of features from moderation to simply
115115
making your life as a moderator easier!
116116
Learn how to create a plugin yourself here:
117-
https://github.com/kyb3r/modmail/wiki/Plugins
117+
https://github.com/modmail-dev/modmail/wiki/Plugins
118118
"""
119119

120120
def __init__(self, bot):
@@ -131,7 +131,7 @@ async def cog_load(self):
131131
logger.info("Plugins not loaded since ENABLE_PLUGINS=false.")
132132

133133
async def populate_registry(self):
134-
url = "https://raw.githubusercontent.com/kyb3r/modmail/master/plugins/registry.json"
134+
url = "https://raw.githubusercontent.com/modmail-dev/modmail/master/plugins/registry.json"
135135
async with self.bot.session.get(url) as resp:
136136
self.registry = json.loads(await resp.text())
137137

cogs/utility.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ async def about(self, ctx):
351351

352352
embed.add_field(
353353
name="Want Modmail in Your Server?",
354-
value="Follow the installation guide on [GitHub](https://github.com/kyb3r/modmail/) "
354+
value="Follow the installation guide on [GitHub](https://github.com/modmail-dev/modmail/) "
355355
"and join our [Discord server](https://discord.gg/F34cRU8)!",
356356
inline=False,
357357
)
@@ -380,7 +380,7 @@ async def sponsors(self, ctx):
380380
"""Shows the sponsors of this project."""
381381

382382
async with self.bot.session.get(
383-
"https://raw.githubusercontent.com/kyb3r/modmail/master/SPONSORS.json"
383+
"https://raw.githubusercontent.com/modmail-dev/modmail/master/SPONSORS.json"
384384
) as resp:
385385
data = loads(await resp.text())
386386

@@ -1941,7 +1941,7 @@ async def update(self, ctx, *, flag: str = ""):
19411941

19421942
desc = (
19431943
f"The latest version is [`{self.bot.version}`]"
1944-
"(https://github.com/kyb3r/modmail/blob/master/bot.py#L1)"
1944+
"(https://github.com/modmail-dev/modmail/blob/master/bot.py#L1)"
19451945
)
19461946

19471947
if self.bot.version >= parse_version(latest.version) and flag.lower() != "force":

core/changelog.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def __init__(self, bot, branch: str, version: str, lines: str):
5353
self.version = version.lstrip("vV")
5454
self.lines = lines.strip()
5555
self.fields = {}
56-
self.changelog_url = f"https://github.com/kyb3r/modmail/blob/{branch}/CHANGELOG.md"
56+
self.changelog_url = f"https://github.com/modmail-dev/modmail/blob/{branch}/CHANGELOG.md"
5757
self.description = ""
5858
self.parse()
5959

@@ -186,7 +186,7 @@ async def from_url(cls, bot, url: str = "") -> "Changelog":
186186
if branch not in ("master", "development"):
187187
branch = "master"
188188

189-
url = url or f"https://raw.githubusercontent.com/kyb3r/modmail/{branch}/CHANGELOG.md"
189+
url = url or f"https://raw.githubusercontent.com/modmail-dev/modmail/{branch}/CHANGELOG.md"
190190

191191
async with await bot.session.get(url) as resp:
192192
return cls(bot, branch, await resp.text())

core/clients.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ class GitHub:
6363
"""
6464

6565
BASE = "https://api.github.com"
66-
REPO = BASE + "/repos/kyb3r/modmail"
66+
REPO = BASE + "/repos/modmail-dev/modmail"
6767
MERGE_URL = BASE + "/repos/{username}/modmail/merges"
6868
FORK_URL = REPO + "/forks"
69-
STAR_URL = BASE + "/user/starred/kyb3r/modmail"
69+
STAR_URL = BASE + "/user/starred/modmail-dev/modmail"
7070

7171
def __init__(self, bot, access_token: str = "", username: str = "", **kwargs):
7272
self.bot = bot

docker-compose.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: "3.7"
22
services:
33
bot:
4-
image: ghcr.io/kyb3r/modmail:master
4+
image: ghcr.io/modmail-dev/modmail:master
55
restart: always
66
env_file:
77
- .env
@@ -10,7 +10,7 @@ services:
1010
depends_on:
1111
- mongo
1212
logviewer:
13-
image: ghcr.io/kyb3r/logviewer:master
13+
image: ghcr.io/modmail-dev/logviewer:master
1414
restart: always
1515
depends_on:
1616
- mongo

pyproject.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ authors = [
3030
3131
]
3232
readme = 'README.md'
33-
repository = 'https://github.com/kyb3r/modmail'
34-
homepage = 'https://github.com/kyb3r/modmail'
33+
repository = 'https://github.com/modmail-dev/modmail'
34+
homepage = 'https://github.com/modmail-dev/modmail'
3535
keywords = ['discord', 'modmail']
3636

3737
[tool.pylint.format]

0 commit comments

Comments
 (0)