You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-2Lines changed: 39 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,45 @@
1
1
# nyantracker player
2
2
3
-
A simple web-based player for chiptune music modules or music tracker, built with WebAssembly and TypeScript. It supports various module formats and provides a user-friendly interface for playback and navigation. Using [DrSnuggles's chiptune3](https://github.com/DrSnuggles/chiptune) for playback and [libopenmpt (WASM)](https://lib.openmpt.org/libopenmpt) for pattern viewer.
A simple web-based player for chiptune music modules or music tracker, built with WebAssembly and TypeScript. It supports various module formats and provides a user-friendly interface for playback and navigation. Using [DrSnuggles's chiptune3](https://github.com/DrSnuggles/chiptune) for playback (via [AudioWorklet](https://developer.mozilla.org/en-US/docs/Web/API/AudioWorklet)) and [libopenmpt (WASM)](https://lib.openmpt.org/libopenmpt) for pattern viewer.
- Support for various module formats (e.g., MOD, XM, S3M, IT)
14
+
- Pattern viewer for visualizing the music structure
15
+
- Oscilloscope for visualizing each channel's output
16
+
- Support multiple sources (local files, modland.com, etc.). You can create your own source by implementing the [`BrowserSource`](./src/sources/base.ts) interface.
17
+
- Support multiple color themes.
18
+
19
+
## Development
20
+
21
+
You must have the latest version of [bun](https://bun.sh/). If not, please install it first.
Then open `http://localhost:5173` in your browser to see the player in action.
31
+
32
+
To build the project, run:
33
+
34
+
```bash
35
+
bun run build
36
+
```
37
+
38
+
## Contributing
39
+
40
+
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request. Please make sure to follow the existing code style and include tests for any new features or bug fixes.
41
+
42
+
AI (or *vibe code*) contributions is closed for now, but feel free to ask for help if you want to contribute.
0 commit comments