Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oamaok/ezpp
pp made easy!
https://github.com/oamaok/ezpp
browser-extension osu
Last synced: 3 months ago
JSON representation
pp made easy!
- Host: GitHub
- URL: https://github.com/oamaok/ezpp
- Owner: oamaok
- License: mit
- Created: 2016-06-08T10:49:24.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-29T20:40:24.000Z (11 months ago)
- Last Synced: 2024-05-02T02:33:51.477Z (6 months ago)
- Topics: browser-extension, osu
- Language: TypeScript
- Size: 1.45 MB
- Stars: 79
- Watchers: 4
- Forks: 23
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-osu - ezpp!
README
# ezpp!
ezpp! is a browser extension that allows you to calculate pp
values for a beatmap without manually downloading the beatmap.
## Translating
All translation efforts are warmly welcome! The base English translations can be found [here](https://github.com/oamaok/ezpp/blob/master/translations/en.json). After translating the file you should also add relevant information to [this file](https://github.com/oamaok/ezpp/blob/master/translations/languages.json), where the `code` field should match with the `.json` file you created. If you are unsure on how to edit the files, feel free to [raise an issue](https://github.com/oamaok/ezpp/issues/new) or ask away in the pull request.
## Developing
### Prerequisities
Versions of software used at the time of writing:
```shell
[teemu@home ezpp]$ node -v
v14.15.4
[teemu@home ezpp]$ yarn -v
1.22.4
```
### Setup
Clone the repository and run the following commands.
```
yarn
```
### Chromium-based browsers
- Run `yarn start:chrome`. This will create a `build/` directory to the repository root.
- Open up Chrome and navigate to `chrome://extensions`.
- Enable `Developer mode`.
- Click the `Load unpacked` button and select the previously mentioned `build` directory.
- The extension is now ready to go!
All the changes made are compiled automatically as long as the `yarn start:chrome` script is running.
To build a production version of the package, run `yarn build:chrome`.
### Firefox
- Run `yarn start:firefox`. This will create a `build/` directory to the repository root.
- Open up Firefox and navigate to `about:debugging#/runtime/this-firefox`.
- Click the `Load Temporary Add-on` button and select any file in the previously mentioned directory.
- The extension is now ready to go!
All the changes made are compiled automatically as long as the `yarn start:firefox` script is running.
To build a production version of the package, run `yarn build:firefox`.
### Production builds
Run `yarn build:all`. Two files, `ezpp-chrome.zip` and `ezpp-firefox.zip`, are generated.
## Installing
Chrome/Chromium: [Install from Google WebStore](https://chrome.google.com/webstore/detail/ezpp/aimihpobjpagjiakhcpijibnaafdniol)
Firefox: [Install from addons.mozilla.org](https://addons.mozilla.org/en-US/firefox/addon/ezpp/)
## License
[MIT](https://github.com/oamaok/ezpp/blob/master/LICENSE)