An open API service indexing awesome lists of open source software.

https://github.com/alexandregv/RP42

Discord Rich Presence integration for @42School
https://github.com/alexandregv/RP42

Last synced: 22 days ago
JSON representation

Discord Rich Presence integration for @42School

Awesome Lists containing this project

README

        

# RP42

A Discord Rich Presence integration for [@42School](https://github.com/42School).
![Screenshot](https://raw.githubusercontent.com/alexandregv/RP42/refs/heads/master/screenshot.png)

- [Installation](#installation)
- [Usage](#usage)
- [Building yourself](#building-yourself)
- [Contributing](#contributing)
- [Contributors](#contributors)
- [Stargazers over time](#stargazers-over-time)

## Installation

1. Download RP42 from the [releases](https://github.com/alexandregv/RP42/releases) page, or build it yourself
2. Create an API App on the Intranet: https://profile.intra.42.fr/oauth/applications/new

Alternatively, if you have Go installed:

```bash
go install github.com/alexandregv/RP42@latest
```

/!\ Do NOT share your API credentials to someone else, or on GitHub, etc. /!\

## Usage

Run the app like this, using the credentials of your API App:

- Linux: `./RP42 -i CLIENT_ID -s CLIENT_SECRET &`
- Windows: `RP42.exe -i CLIENT_ID -s CLIENT_SECRET`
- MacOS: `./RP42 -i CLIENT_ID -s CLIENT_SECRET`

On Linux, to run it in background as a service, create a file `~/.config/systemd/user/RP42.service` with this content:

```ini
[Unit]
Description=Discord Rich Presence for 42

[Service]
ExecStart=%h/.local/bin/RP42 -i -s
Restart=always

[Install]
WantedBy=default.target
```

Then run `systemctl --user start RP42` and `systemctl --user status RP42`.

## Building yourself

If you want to build RP42 yourself, follow these instructions:

1. Clone the repo: `git clone https://github.com/alexandregv/RP42.git`
2. Compile: `make` for all distro, or `make linux` / `make macos` / `make windows`

## Contributing

1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [alexandregv/aguiot--](https://github.com/alexandregv) - creator and maintainer

## Stargazers over time

[![Stargazers over time](https://starchart.cc/alexandregv/RP42.svg?variant=adaptive)](https://starchart.cc/alexandregv/RP42)