https://github.com/walfie/ac-tune-maker
Animal Crossing tune maker
https://github.com/walfie/ac-tune-maker
acnh animal-crossing animal-crossing-new-horizons
Last synced: about 1 month ago
JSON representation
Animal Crossing tune maker
- Host: GitHub
- URL: https://github.com/walfie/ac-tune-maker
- Owner: walfie
- License: mit
- Created: 2020-03-09T03:49:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-31T02:00:28.000Z (8 months ago)
- Last Synced: 2024-11-19T21:36:09.574Z (7 months ago)
- Topics: acnh, animal-crossing, animal-crossing-new-horizons
- Language: OCaml
- Homepage: https://ac-tune-maker.aikats.us/
- Size: 1.35 MB
- Stars: 79
- Watchers: 5
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Animal Crossing Tune Maker
[](https://github.com/walfie/ac-tune-maker/actions)
A website for making Animal Crossing tunes, written in OCaml with
[Bucklescript-TEA](https://github.com/OvermindDL1/bucklescript-tea).
## Development
- Install dependencies
```sh
yarn install
```
- Run the development server
```sh
yarn dev
```
This will start a dev server on and auto-reload as
changes are made.
Note that the SVG files are written manually and it's not recommended to make
changes to them via a visual editor, since the code depends on certain
classes/elements to exist.
## Production
```sh
yarn run build
```
Artifacts will be found in the `dist` directory on success.
If deploying to GitHub pages, there's also a `yarn run deploy` script which will
build and push to your `origin/gh-pages` branch (make sure to override the value
in `static/CNAME` if you're using your CNAME).
## Editor setup (Optional)
- Install opam (OCaml Package Manager)
-
- Install OCaml 4.06.1 (Note: BuckleScript requires 4.06.x)
```sh
opam switch create 4.06.1
```
- Install OCaml-LSP and ocamlformat
```sh
opam pin add ocaml-lsp-server https://github.com/ocaml/ocaml-lsp.git
opam install ocaml-lsp-server
```
```sh
opam install ocamlformat
```
- If you are using VSCode, install
[OCaml Platform - OCaml Labs](https://marketplace.visualstudio.com/items?itemName=ocamllabs.ocaml-platform);
otherwise, use any LSP client.