liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: update github repo URL

Browse Source
This commit is contained in:
spiral 2022-06-05 12:57:10 -04:00
parent 89a770d59b
commit a18fd9bd0d
No known key found for this signature in database
GPG Key ID: 244A11E4B0BCF40E
14 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.github/workflows/docker.yml vendored
View File

@ -7,7 +7,7 @@ jobs:
runs-on: ubuntu-latest
permissions:
packages: write
if: github.repository == 'xSke/PluralKit'
if: github.repository == 'PluralKit/PluralKit'
steps:
- uses: docker/login-action@v1
with:
@ -22,8 +22,8 @@ jobs:
context: .
push: true
tags: |
ghcr.io/xske/pluralkit:${{ env.BRANCH_NAME }}
ghcr.io/xske/pluralkit:${{ github.sha }}
ghcr.io/xske/pluralkit:latest
cache-from: type=registry,ref=ghcr.io/xske/pluralkit:${{ env.BRANCH_NAME }}
ghcr.io/pluralkit/pluralkit:${{ env.BRANCH_NAME }}
ghcr.io/pluralkit/pluralkit:${{ github.sha }}
ghcr.io/pluralkit/pluralkit:latest
cache-from: type=registry,ref=ghcr.io/pluralkit/pluralkit:${{ env.BRANCH_NAME }}
cache-to: type=inline

2
.github/workflows/gateway.yml vendored
View File

@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
permissions:
packages: write
if: github.repository == 'xSke/PluralKit'
if: github.repository == 'PluralKit/PluralKit'
steps:
- uses: docker/login-action@v1
with:

2
Dockerfile
View File

@ -20,7 +20,7 @@ RUN dotnet build -c Release -o bin
# Build runtime stage (doesn't include SDK)
FROM mcr.microsoft.com/dotnet/aspnet:6.0
LABEL org.opencontainers.image.source = "https://github.com/xSke/PluralKit"
LABEL org.opencontainers.image.source = "https://github.com/PluralKit/PluralKit"
WORKDIR /app
COPY --from=build /app ./

2
Myriad/Rest/DiscordApiClient.cs
View File

@ -10,7 +10,7 @@ namespace Myriad.Rest;
public class DiscordApiClient
{
public const string UserAgent = "DiscordBot (https://github.com/xSke/PluralKit/tree/main/Myriad/, v1)";
public const string UserAgent = "DiscordBot (https://github.com/PluralKit/PluralKit/tree/main/Myriad/, v1)";
private const string DefaultApiBaseUrl = "https://discord.com/api/v10";
private readonly BaseRestClient _client;

2
PluralKit.Bot/Commands/Help.cs
View File

@ -63,7 +63,7 @@ public class Help
"We also have a Discord server for support, discussion, suggestions, announcements, etc: https://discord.gg/PczBt78"
)
},
Footer = new("By @Ske#6201 | Myriad by @Layl#8888 | GitHub: https://github.com/xSke/PluralKit/ | Website: https://pluralkit.me/"),
Footer = new("By @Ske#6201 | Myriad by @Layl#8888 | GitHub: https://github.com/PluralKit/PluralKit/ | Website: https://pluralkit.me/"),
Color = DiscordUtils.Blue,
};

2
PluralKit.Bot/Commands/Misc.cs
View File

@ -127,7 +127,7 @@ public class Misc
.Footer(new(String.Join(" \u2022 ", new[] {
$"PluralKit {BuildInfoService.Version}",
(isCluster ? $"Cluster {_botConfig.Cluster.NodeIndex}" : ""),
"https://github.com/xSke/PluralKit",
"https://github.com/PluralKit/PluralKit",
"Last restarted:",
})))
.Timestamp(process.StartTime.ToString("O"));

2
PluralKit.Bot/Proxy/ProxyTagParser.cs
View File

@ -78,7 +78,7 @@ public class ProxyTagParser
// We got a match, extract inner text
inner = input.Substring(prefix.Length, input.Length - prefix.Length - suffix.Length);
// (see https://github.com/xSke/PluralKit/pull/181)
// (see https://github.com/PluralKit/PluralKit/pull/181)
return inner.Trim() != "\U0000fe0f";
}

8
README.md
View File

@ -11,7 +11,7 @@ Running the bot requires [.NET 5](https://dotnet.microsoft.com/download) and a P
Optionally, it can integrate with [Sentry](https://sentry.io/welcome/) for error reporting and [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) for aggregate statistics.
# Configuration
Configuring the bot is done through a JSON configuration file. An example of the configuration format can be seen in [`pluralkit.conf.example`](https://github.com/xSke/PluralKit/blob/master/pluralkit.conf.example).
Configuring the bot is done through a JSON configuration file. An example of the configuration format can be seen in [`pluralkit.conf.example`](https://github.com/PluralKit/PluralKit/blob/master/pluralkit.conf.example).
The configuration file needs to be placed in the bot's working directory (usually the repository root) and must be called `pluralkit.conf`.
The configuration file is in JSON format (albeit with a `.conf` extension). The following keys are available (using `.` to indicate a nested object level), bolded key names are required:
@ -31,7 +31,7 @@ The bot can also take configuration from environment variables, which will overr
## Docker
The easiest way to get the bot running is with Docker. The repository contains a `docker-compose.yml` file ready to use.
* Clone this repository: `git clone https://github.com/xSke/PluralKit`
* Clone this repository: `git clone https://github.com/PluralKit/PluralKit`
* Create a `pluralkit.conf` file in the same directory as `docker-compose.yml` containing at least a `PluralKit.Bot.Token` field
* (`PluralKit.Database` is overridden in `docker-compose.yml` to point to the Postgres container)
* Build the bot: `docker-compose build`
@ -39,7 +39,7 @@ The easiest way to get the bot running is with Docker. The repository contains a
In other words:
```
$ git clone https://github.com/xSke/PluralKit
$ git clone https://github.com/PluralKit/PluralKit
$ cd PluralKit
$ cp pluralkit.conf.example pluralkit.conf
$ nano pluralkit.conf # (or vim, or whatever)
@ -48,7 +48,7 @@ $ docker-compose up -d
## Manually
* Install the .NET 6 SDK (see https://dotnet.microsoft.com/download)
* Clone this repository: `git clone https://github.com/xSke/PluralKit`
* Clone this repository: `git clone https://github.com/PluralKit/PluralKit`
* Create and fill in a `pluralkit.conf` file in the same directory as `docker-compose.yml`
* Run the bot: `dotnet run --project PluralKit.Bot`
* Alternatively, `dotnet build -c Release -o build/`, then `dotnet build/PluralKit.Bot.dll`

2
dashboard/src/pages/status.svelte
View File

@ -37,7 +37,7 @@
return shard;
});
currentCommitMsg = `Current Git commit: <a href="https://github.com/xSke/PluralKit/commit/${pkdata.version}">${pkdata.version.slice(0,7)}</a>`;
currentCommitMsg = `Current Git commit: <a href="https://github.com/PluralKit/PluralKit/commit/${pkdata.version}">${pkdata.version.slice(0,7)}</a>`;
if (data[0].cluster_id === 0) {
let clusterData = {};

2
docs/content/.vuepress/config.js
View File

@ -18,7 +18,7 @@ module.exports = {
},
themeConfig: {
repo: 'xSke/PluralKit',
repo: 'PluralKit/PluralKit',
docsDir: 'docs/content/',
docsBranch: 'main',
editLinks: true,

2
docs/content/api/changelog.md
View File

@ -15,7 +15,7 @@ permalink: /api/changelog
* The API now has values for granular member privacy. The new fields are as follows: `visibility`, `name_privacy`, `description_privacy`, `avatar_privacy`, `birthday_privacy`, `pronoun_privacy`, `metadata_privacy`. All are strings and accept the values of `public`, `private` and `null`.
* The `privacy` field has now been deprecated and should not be used. It's still returned (mirroring the `visibility` field), and writing to it will write to *all privacy options*.
* 2020-05-07
* The API (v1) is now formally(ish) defined with OpenAPI v3.0. [The definition file can be found here.](https://github.com/xSke/PluralKit/blob/master/PluralKit.API/openapi.yaml)
* The API (v1) is now formally(ish) defined with OpenAPI v3.0. [The definition file can be found here.](https://github.com/PluralKit/PluralKit/blob/master/PluralKit.API/openapi.yaml)
* 2020-02-10
* Birthdates with no year can now be stored using `0004` as a year, for better leap year support. Both options remain valid and either may be returned by the API.
* Added privacy set/get support, meaning you will now see privacy values in authed requests and can set them.

6
docs/content/faq.md
View File

@ -21,7 +21,7 @@ Although this bot is designed with plural systems and their use cases in mind, t
You can suggest features in the [support server](https://discord.gg/PczBt78)'s `#suggestions-feedback` channel. Check the `#frequent-suggestions` channel to see if your idea has already been suggested!
We also track feature requests through [Github Issues](https://github.com/xSke/PluralKit/issues). Feel free to open issue reports or feature requests there as well.
We also track feature requests through [Github Issues](https://github.com/PluralKit/PluralKit/issues). Feel free to open issue reports or feature requests there as well.
### How can I support the bot's development?
I (the bot author, [Ske](https://twitter.com/floofstrid)) have a Patreon. The income from there goes towards server hosting, domains, infrastructure, my Monster Energy addiction, et cetera. There are no benefits. There might never be any. But nevertheless, it can be found here: [https://www.patreon.com/floofstrid](https://www.patreon.com/floofstrid)
@ -32,7 +32,7 @@ I (the bot author, [Ske](https://twitter.com/floofstrid)) have a Patreon. The in
The only people with access to the database or the information the bot processes is the developer, no one else has access. More information about how information is processed is described on the [Privacy Policy](/privacy).
But in short: the bot does not save or log messages beyond metadata necessary for the bot's functioning, and we do not have the ability to read messages going through the bot, proxied or not. The bot is [open-source](https://github.com/xSke/PluralKit), so anyone with technical knowledge can confirm this.
But in short: the bot does not save or log messages beyond metadata necessary for the bot's functioning, and we do not have the ability to read messages going through the bot, proxied or not. The bot is [open-source](https://github.com/PluralKit/PluralKit), so anyone with technical knowledge can confirm this.
### I set all my privacy options to private. Why can others still see some information?
There are two possible answers here:
@ -45,7 +45,7 @@ This includes:
* the information that would be shown when a member proxies (proxy name/avatar image);
* and the system ID on a member card.
For more information about why certain information must be public, see [this github issue](https://github.com/xSke/PluralKit/issues/238).
For more information about why certain information must be public, see [this github issue](https://github.com/PluralKit/PluralKit/issues/238).
### Is there a way to restrict PluralKit usage to a certain role? / Can I remove PluralKit access for specific users in my server?
This is not a feature currently available in PluralKit. It may be added in the future.

4
docs/content/privacy-policy.md
View File

@ -25,11 +25,11 @@ This is the data PluralKit does *not* collect:
System and member information (names, member lists, descriptions, etc) are public by default, and can be looked up by anyone given a system/member ID or an account ID. This can be changed using the [privacy settings](/guide#privacy).
You can export your system information using the `pk;export` command. This does not include message metadata (as the file would be huge). If there's demand for a command to export that, [let me know on GitHub](https://github.com/xSke/PluralKit/issues).
You can export your system information using the `pk;export` command. This does not include message metadata (as the file would be huge). If there's demand for a command to export that, [let me know on GitHub](https://github.com/PluralKit/PluralKit/issues).
You can delete your information using `pk;system delete`. This will delete all system information and associated members, switches, and messages. This will not delete your information from the database backups. Contact me if you want that wiped, too.
The bot is [open-source](https://github.com/xSke/PluralKit). While I can't *prove* this is the code that's running on the production server... it is, promise.
The bot is [open-source](https://github.com/PluralKit/PluralKit). While I can't *prove* this is the code that's running on the production server... it is, promise.
## Website

2
docs/content/user-guide.md
View File

@ -286,7 +286,7 @@ You can have any proxy tags you want, including one containing emojis.
You can now type a message enclosed in your proxy tags, and it'll be deleted by PluralKit and reposted with the appropriate member name and avatar (if set).
**NB:** If you want `<angle brackets>` as proxy tags, there is currently a bug where custom server emojis will (wrongly)
be interpreted as proxying with that member (see [issue #37](https://github.com/xSke/PluralKit/issues/37)). The current workaround is to use different proxy tags.
be interpreted as proxying with that member (see [issue #37](https://github.com/PluralKit/PluralKit/issues/37)). The current workaround is to use different proxy tags.
### Using multiple distinct proxy tag pairs
If you'd like to proxy a member in multiple ways (for example, a name or a nickname, uppercase and lowercase variants, etc), you can add multiple tag pairs.