ethanaobrien/EmulatorJS
1
0
Fork 0
mirror of https://github.com/EmulatorJS/EmulatorJS.git synced 2024-09-20 10:56:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
EmulatorJS/README.md

199 lines
5.6 KiB
Markdown
Raw Normal View History

Update README.md
2022-02-23 15:03:52 +00:00
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
<div align = center>
Version 3.0.5 is finally here! Changes: - Fixed screen recording on devices that do not support getUserMedia api. - Added C label buttons to nintendo 64 virtual gamepad. - Fixed EJS_color bug. - Savestates are pulled from the core itself, to always be correct. - Several new cores. (a5200, beetle_vb, desmume2015, fbalpha2012_cps1, fbalpha2012_cps2, fceumm, gambatte, mame2003, mednafen_psx, mednafen_psx_hw, melonds, mgba, mupen64plus_next, nestopia, snes9x) - D-pad for virtual gamepad. - Updated translation files to include new menu options. - Ability to add more than one zone object to virtual gamepads. - Added ability to set custom menu options. - Virtual gamepad left handed mode. - Fixed Screen record svg. - Updated svg icons. - Cache "clear all" button. - Cache button moved to menu bar. - Added feature that will display the current downloaded size when the content length is not available. - Updated repository docs
2022-09-24 17:50:44 +00:00
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
<img width = 300 src = docs/Logo-light.png#gh-dark-mode-only>
<img width = 300 src = docs/Logo.png#gh-light-mode-only>
<br>
<br>
[![Badge License]][License]
Self-hosted **Javascript** emulation for various system.
<br>
[![Button Website]][Website] 
[![Button Usage]][Usage]<br>
[![Button Configurator]][Configurator]<br>
[![Button Demo]][Demo] 
Version 3.0.5 is finally here! Changes: - Fixed screen recording on devices that do not support getUserMedia api. - Added C label buttons to nintendo 64 virtual gamepad. - Fixed EJS_color bug. - Savestates are pulled from the core itself, to always be correct. - Several new cores. (a5200, beetle_vb, desmume2015, fbalpha2012_cps1, fbalpha2012_cps2, fceumm, gambatte, mame2003, mednafen_psx, mednafen_psx_hw, melonds, mgba, mupen64plus_next, nestopia, snes9x) - D-pad for virtual gamepad. - Updated translation files to include new menu options. - Ability to add more than one zone object to virtual gamepads. - Added ability to set custom menu options. - Virtual gamepad left handed mode. - Fixed Screen record svg. - Updated svg icons. - Cache "clear all" button. - Cache button moved to menu bar. - Added feature that will display the current downloaded size when the content length is not available. - Updated repository docs
2022-09-24 17:50:44 +00:00
[![Button Legacy]][Legacy]
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
[![Button Contributors]][Contributors]
add discord server to README
2023-05-11 15:39:11 +00:00
Join our Discord server:
Fix discord invite widget
2023-06-19 21:59:52 +00:00
[![Join our Discord server!](https://invite.caspertheghost.me/?inviteCode=6akryGkETU&format=svg)](https://discord.gg/6akryGkETU)
add discord server to README
2023-05-11 15:39:11 +00:00
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
</div>
<br>
Notify users this is a re-write
2023-07-18 17:24:40 +00:00
**As of EmulatorJS version 4.0, this project is no longer a reverse-engineered version of the emulatorjs.com project. It is now a complete re-write,**
<br>
EmulatorJS Version 4.0 See Changelog for information. I'm deeply sorry to anyone with active branches, and good luck with merge conflicts
2023-07-18 17:13:07 +00:00
**README BEFORE YOU UPDATE:** EmulatorJS Version 4.0 is a complete re-write of the application. At least some bugs are expected. If you did any communicating with the emulator, there is a 100% chance you will need to re-write your project, and to people with active branches of this project, I wish you luck with merge conflicts (I'm very sorry). The emulator object can be accessed through the `window.EJS_emulator` object.
It is **HIGHLY** suggested that you update to 4.0 ASAP.
<br>
(for now) add ads (only to the demo page) to be able to pay for project utilities
2022-11-25 15:23:33 +00:00
### Ads
*This project has no ads.* <br>
*Although, the demo page currently has an ad to help fund this project.* <br>
*Ads on the demo page may come and go depending on how many people are* <br>
*funding this project.* <br>
*You can help fund this project on* ***[patreon]***
<br>
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
### Issues
*If something doesn't work, please consider opening an* ***[Issue]*** <br>
*with as many details as possible, as well as the console log.*
<br>
### Extensions
 **[GameLibrary]**
   *A library overview for your **ROM** folder.*
<br>
**>> When reporting bugs, please specify that you are using the old version**
<br>
<br>
<br>
<h1 align = center>Supported Systems</h1>
<br>
<div align = center>
### Nintendo
**[Game Boy Advance][Nintendo Game Boy Advance]**   | 
**[Famicom / NES][NES / Famicom]**   | 
**[Virtual Boy][Virtual Boy]**
**[Game Boy][Nintendo Game Boy]**   | 
**[SNES]**   | 
**[DS][Nintendo DS]**   | 
**[64][Nintendo 64]**
<br>
<br>
### Sega
**[Master System][Sega Master System]**   | 
**[Mega Drive][Sega Mega Drive]**   | 
**[Game Gear][Sega Game Gear]**
**[Saturn][Sega Saturn]**   | 
**[CD][Sega CD]**
<br>
<br>
### Atari
Fix atari lines
2022-09-14 22:13:51 +00:00
**[2600][Atari 2600]**   | 
**[5200][Atari 5200]**   | 
**[7800][Atari 7800]**   | 
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
**[Lynx][Atari Lynx]**   | 
**[Jaguar][Atari Jaguar]**
<br>
<br>
### Other
**[PlayStation]**   | 
**[Arcade]**   | 
Version 3.0.5 is finally here! Changes: - Fixed screen recording on devices that do not support getUserMedia api. - Added C label buttons to nintendo 64 virtual gamepad. - Fixed EJS_color bug. - Savestates are pulled from the core itself, to always be correct. - Several new cores. (a5200, beetle_vb, desmume2015, fbalpha2012_cps1, fbalpha2012_cps2, fceumm, gambatte, mame2003, mednafen_psx, mednafen_psx_hw, melonds, mgba, mupen64plus_next, nestopia, snes9x) - D-pad for virtual gamepad. - Updated translation files to include new menu options. - Ability to add more than one zone object to virtual gamepads. - Added ability to set custom menu options. - Virtual gamepad left handed mode. - Fixed Screen record svg. - Updated svg icons. - Cache "clear all" button. - Cache button moved to menu bar. - Added feature that will display the current downloaded size when the content length is not available. - Updated repository docs
2022-09-24 17:50:44 +00:00
**[3DO]**   | 
**[MAME 2003]**
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
</div>
<br>
<!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 --->
[License]: LICENSE
Version 3.0.5 is finally here! Changes: - Fixed screen recording on devices that do not support getUserMedia api. - Added C label buttons to nintendo 64 virtual gamepad. - Fixed EJS_color bug. - Savestates are pulled from the core itself, to always be correct. - Several new cores. (a5200, beetle_vb, desmume2015, fbalpha2012_cps1, fbalpha2012_cps2, fceumm, gambatte, mame2003, mednafen_psx, mednafen_psx_hw, melonds, mgba, mupen64plus_next, nestopia, snes9x) - D-pad for virtual gamepad. - Updated translation files to include new menu options. - Ability to add more than one zone object to virtual gamepads. - Added ability to set custom menu options. - Virtual gamepad left handed mode. - Fixed Screen record svg. - Updated svg icons. - Cache "clear all" button. - Cache button moved to menu bar. - Added feature that will display the current downloaded size when the content length is not available. - Updated repository docs
2022-09-24 17:50:44 +00:00
[Issue]: https://github.com/ethanaobrien/emulatorjs/issues
(for now) add ads (only to the demo page) to be able to pay for project utilities
2022-11-25 15:23:33 +00:00
[patreon]: https://patreon.com/EmulatorJS
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
<!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 Extensions 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 --->
[GameLibrary]: https://github.com/Ramaerel/emulatorjs-GameLibrary
<!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 Quicklinks 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 --->
Update to new emulatorjs.org website
2022-10-23 17:18:23 +00:00
[Configurator]: https://emulatorjs.org/editor.html
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
[Contributors]: docs/Contributors.md
Update to new emulatorjs.org website
2022-10-23 17:18:23 +00:00
[Website]: https://emulatorjs.org/
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
[Legacy]: https://coldcast.org/games/1/Super-Mario-Bros
Update to new emulatorjs.org website
2022-10-23 17:18:23 +00:00
[Usage]: https://emulatorjs.org/docs/
Update demo website to: demo.emulatorjs.org
2022-11-08 15:59:09 +00:00
[Demo]: https://demo.emulatorjs.org/
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
<!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 Systems 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 -->
[Nintendo Game Boy Advance]: docs/Systems/Nintendo%20Game%20Boy%20Advance.md
[Nintendo Game Boy]: docs/Systems/Nintendo%20Game%20Boy.md
[Nintendo 64]: docs/Systems/Nintendo%2064.md
[Nintendo DS]: docs/Systems/Nintendo%20DS.md
[Sega Master System]: docs/Systems/Sega%20Master%20System.md
[Sega Mega Drive]: docs/Systems/Sega%20Mega%20Drive.md
[Sega Game Gear]: docs/Systems/Sega%20Game%20Gear.md
[Sega Saturn]: docs/Systems/Sega%20Saturn.md
[Sega 32X]: docs/Systems/Sega%2032X.md
[Sega CD]: docs/Systems/Sega%20CD.md
[Atari Jaguar]: docs/Systems/Atari%20Jaguar.md
[Atari Lynx]: docs/Systems/Atari%20Lynx.md
[Atari 7800]: docs/Systems/Atari%207800.md
[Atari 2600]: docs/Systems/Atari%202600.md
[Atari 5200]: docs/Systems/Atari%205200.md
[NES / Famicom]: docs/Systems/NES-Famicom.md
[SNES]: docs/Systems/SNES.md
[TurboGrafs-16 / PC Engine]: docs/Systems/TurboGrafs%2016-PC%20Engine.md
[WanderSwan / Color]: docs/Systems/WanderSwan-Color.md
[Neo Geo Poket]: docs/Systems/Neo%20Geo%20Poket.md
[PlayStation]: docs/Systems/PlayStation.md
[Virtual Boy]: docs/Systems/Virtual%20Boy.md
[Arcade]: docs/Systems/Arcade.md
[MSX]: docs/Systems/MSX.md
[3DO]: docs/Systems/3DO.md
Version 3.0.5 is finally here! Changes: - Fixed screen recording on devices that do not support getUserMedia api. - Added C label buttons to nintendo 64 virtual gamepad. - Fixed EJS_color bug. - Savestates are pulled from the core itself, to always be correct. - Several new cores. (a5200, beetle_vb, desmume2015, fbalpha2012_cps1, fbalpha2012_cps2, fceumm, gambatte, mame2003, mednafen_psx, mednafen_psx_hw, melonds, mgba, mupen64plus_next, nestopia, snes9x) - D-pad for virtual gamepad. - Updated translation files to include new menu options. - Ability to add more than one zone object to virtual gamepads. - Added ability to set custom menu options. - Virtual gamepad left handed mode. - Fixed Screen record svg. - Updated svg icons. - Cache "clear all" button. - Cache button moved to menu bar. - Added feature that will display the current downloaded size when the content length is not available. - Updated repository docs
2022-09-24 17:50:44 +00:00
[MAME 2003]: docs/Systems/MAME%202003.md
Actually - lets transfer the repository
2022-09-14 18:15:53 +00:00
<!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 Badges 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 --->
[Badge License]: https://img.shields.io/badge/License-GPLv3-blue.svg?style=for-the-badge
[Button Configurator]: https://img.shields.io/badge/Configurator-992cb3?style=for-the-badge
[Button Contributors]: https://img.shields.io/badge/Contributors-54b7dd?style=for-the-badge
[Button Website]: https://img.shields.io/badge/Website-736e9b?style=for-the-badge
[Button Legacy]: https://img.shields.io/badge/Legacy-ab910b?style=for-the-badge
[Button Usage]: https://img.shields.io/badge/Usage-2478b5?style=for-the-badge
[Button Demo]: https://img.shields.io/badge/Demo-528116?style=for-the-badge
[Button Beta]: https://img.shields.io/badge/Beta-bb044f?style=for-the-badge
Reference in a new issue Copy permalink