https://github.com/cl8n/project-loved

Generates announcements for osu!'s "Project Loved"
https://github.com/cl8n/project-loved

osu osu-forums osu-wiki project-loved

Last synced: 9 days ago
JSON representation

Generates announcements for osu!'s "Project Loved"

• Host: GitHub
• URL: https://github.com/cl8n/project-loved
• Owner: cl8n
• License: mit-0
• Created: 2018-04-22T13:11:36.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-21T21:54:03.000Z (3 months ago)
• Last Synced: 2024-08-22T22:41:33.738Z (3 months ago)
• Topics: osu, osu-forums, osu-wiki, project-loved
• Language: JavaScript
• Homepage:
• Size: 3.42 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
This project contains the tools required to generate announcements, forum threads and related content for osu!'s [Project Loved](https://osu.ppy.sh/wiki/Project_Loved). See [cl8n/project-loved-web](https://github.com/cl8n/project-loved-web) for the website.

## Dependencies

- [Node.js](https://nodejs.org/en/download/) 18

- [git](https://git-scm.com/) (optional, for auto-updating the repository when running commands)

## Usage

A typical round of Project Loved involves:

- Messaging mappers of nominated mapsets: `npm run messages`

- Creating a news post: `npm run news -- `

- Opening forum polls and optionally updating the news post: `npm run news:forum [-- ]`

- Posting results when forum polls have concluded: `npm run results`

### Setup

`npm run setup` will create the needed config files and runtime folders.

### Config

`config/config.json` contains these options:

| Option | Description |

| :-- | :-- |

| `apiClient.id` | API client ID for chat announcements |

| `apiClient.secret` | API client secret for chat announcements |

| `bannerTitleOverrides.` | Alternate beatmapset title for banner images |

| `cloudflare.id` | https://osu.ppy.sh's `__cfduid` cookie (may be blank) |

| `cloudflare.clearance` | https://osu.ppy.sh's `cf_clearance` cookie (may be blank) |

| `csrf` | The result of `document.querySelector('[name=csrf-token]').content` on any https://osu.ppy.sh page |

| `lovedApiKey` | API key for https://loved.sh |

| `lovedBaseUrl` | Base URL for https://loved.sh |

| `lovedRoundId` | ID of the round on https://loved.sh |

| `osuBaseUrl` | Base URL for https://osu.ppy.sh |

| `pollStartGuess` | Guess for when the polls will be published. Used in PMs |

| `session` | https://osu.ppy.sh's `osu_session` cookie |

| `userAgent` | `User-Agent` header |

Cloudflare, CSRF, session, and user agent options are used to spoof a normal session on the osu! website. This is used for the few cases where the public API doesn't support all of the actions of this program, for example moderating the Loved forum. Understand that this data is enough to give complete access to your account and don't run this program if you don't fully trust it.

When creating the API client for chat announcements, set the "Application Callback URL" field to `http://localhost:18888`.

In addition to `config.json`, you need to provide beatmap backgrounds for each of the mapsets included in the current round. Their filenames (not including the extension) must match the beatmapset ID. Run `npm run maps:download` to download most of them automatically.