Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ponceto/aym-js
AYM·JS a AY-3-8910 & YM2149 sound chip emulator written in JavaScript [this repository is a mirror]
https://github.com/ponceto/aym-js
Last synced: about 2 months ago
JSON representation
AYM·JS a AY-3-8910 & YM2149 sound chip emulator written in JavaScript [this repository is a mirror]
- Host: GitHub
- URL: https://github.com/ponceto/aym-js
- Owner: ponceto
- License: gpl-2.0
- Created: 2023-09-14T12:53:37.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-18T12:52:12.000Z (2 months ago)
- Last Synced: 2024-07-18T15:43:40.143Z (2 months ago)
- Language: HTML
- Homepage:
- Size: 9.19 MB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING
- Authors: AUTHORS
Awesome Lists containing this project
README
# AYM·JS
## ABSTRACT
AYM·JS is a sound chip emulator written in JavaScript.
### DESCRIPTION
AYM·JS is designed to emulate these venerable and famous sound chips directly in your browser:
- the AY-3-8910 PSG (Programmable Sound Generator)
- the YM2149 SSG (Software-Controlled Sound Generator)
This project respects the [KISS](https://en.wikipedia.org/wiki/KISS_principle) principle and is just based on the [Hugo static website generator](https://gohugo.io) and the `make` utility.
No `node`, `npm` or whatever... Just plain HTML and vanilla JavaScript, [FontAwesome](https://fontawesome.com/) and [Pico·CSS](https://picocss.com/).
Somme old musics are shipped with this project. These musics are converted from the [ym file format](http://leonard.oxg.free.fr/ymformat.html) to JavaScript with a custom tool written in C++ which will be released later.
Custom playlists and support the ym file format for the player are planned and will be added later to this project.
## SOURCES
The source code for the emulator itself is located in the following directory:
- [src/static/vendor/aym-js/](src/static/vendor/aym-js/)
The emulator can be used in any project as long as the terms of the GPL-v2 license are respected.
## DEPENDENCIES
This project requires `hugo` v0.110.0 or higher and `make`.
On Linux based systems you just have to install the dependencies with your favorite package manager.
For example:
```
sudo apt install hugo make
```
## HOWTO
There is a `Makefile` to do most of the tasks. You just have to type `make` with the following targets.
### MAKE SERVE
The `make serve` command calls the `bin/hugo-serve.sh` script in order to starts the builtin webserver.
After running this command, open your web browser and go to [http://localhost:1313](http://localhost:1313).
Example:
```
make serve
```
### MAKE BUILD
The `make` or `make all` or `make build` command calls the `bin/hugo-build.sh` script in order to build the project.
After running this command, the `src/public` directory will contain the built project.
Example:
```
make
```
or
```
make all
```
or
```
make build
```
### MAKE CLEAN
The `make clean` command calls the `bin/hugo-clean.sh` script in order to clean the project.
After running this command, the `src/public` directory will be fully cleaned.
Example:
```
make clean
```
### MAKE DEPLOY
The `make deploy` command calls the `bin/hugo-deploy.sh` script in order to deploy the project on your server.
After running this command, the project will be available on your server.
Example:
```
make deploy
```
## LICENSE TERMS
### AYM·JS
This project is released under the terms of the General Public License version 2.
```
aym-js - Copyright (c) 2001-2024 - Olivier Poncet
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
```
### FONTAWESOME
This project is distributed with [fontawesome](https://fontawesome.com/), an icon library and toolkit.
```
Font Awesome Free License
Font Awesome Free is free, open source, and GPL friendly. You can use it for
commercial projects, open source projects, or really almost whatever you want.
Full Font Awesome Free license: https://fontawesome.com/license/free.
```
### PICO·CSS
This project is distributed with [pico·css](https://picocss.com/), a tiny and elegant css library.
```
MIT License
Copyright (c) 2019-2023 Pico
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
### MUSICS
This project is distributed with some examples of musics.
```
Although they may be considered abandonware, the musics provided
with this package are protected under the copyrights of their authors.
```