ShuriZma
/
melonDS
mirror of https://github.com/melonDS-emu/melonDS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
melonDS/README.md

71 lines
3.6 KiB
Markdown
Raw Normal View History

Update repo URL in README.md
2022-09-14 17:02:22 +00:00
<p align="center"><img src="https://raw.githubusercontent.com/melonDS-emu/melonDS/master/res/icon/melon_128x128.png"></p>
Changed the readme to make it look a little fancier
2018-11-01 06:11:11 +00:00
<h2 align="center"><b>melonDS</b></h2>
<p align="center">
<a href="http://melonds.kuribo64.net/" alt="melonDS website"><img src="https://img.shields.io/badge/website-melonds.kuribo64.net-%2331352e.svg"></a>
BAHAHAHAHAHAJSKASLASJISFS--+|*~+-.
2022-11-03 19:35:21 +00:00
<a href="http://melonds.kuribo64.net/downloads.php" alt="Release: 0.9.5"><img src="https://img.shields.io/badge/release-0.9.5-%235c913b.svg"></a>
Changed the readme to make it look a little fancier
2018-11-01 06:11:11 +00:00
<a href="https://www.gnu.org/licenses/gpl-3.0" alt="License: GPLv3"><img src="https://img.shields.io/badge/License-GPL%20v3-%23ff554d.svg"></a>
<a href="https://kiwiirc.com/client/irc.badnik.net/?nick=IRC-Source_?#melonds" alt="IRC channel: #melonds"><img src="https://img.shields.io/badge/IRC%20chat-%23melonds-%23dd2e44.svg"></a>
Add Discord invite link to README.md
2024-07-02 08:06:05 +00:00
<a href="https://discord.gg/pAMAtExcqV" alt="Discord"><img src="https://img.shields.io/badge/Discord-Kuribo64-7289da?logo=discord&logoColor=white"></a>
Add build status badges
2021-02-04 10:10:49 +00:00
<br>
fix README build badges finally
2024-05-05 06:40:37 +00:00
<a href="https://github.com/melonDS-emu/melonDS/actions/workflows/build-windows.yml?query=event%3Apush"><img src="https://github.com/melonDS-emu/melonDS/actions/workflows/build-windows.yml/badge.svg" /></a>
<a href="https://github.com/melonDS-emu/melonDS/actions/workflows/build-ubuntu.yml?query=event%3Apush"><img src="https://github.com/melonDS-emu/melonDS/actions/workflows/build-ubuntu.yml/badge.svg" /></a>
<a href="https://github.com/melonDS-emu/melonDS/actions/workflows/build-macos.yml?query=event%3Apush"><img src="https://github.com/melonDS-emu/melonDS/actions/workflows/build-macos.yml/badge.svg" /></a>
Changed the readme to make it look a little fancier
2018-11-01 06:11:11 +00:00
</p>
Fix README formatting
2017-10-22 03:58:02 +00:00
DS emulator, sorta
first real commit, some shit is in
2016-05-16 01:40:11 +00:00
maybe this shit will finally work. also update the README.
2017-03-29 20:56:30 +00:00
The goal is to do things right and fast, akin to blargSNES (but hopefully better). But also to, you know, have a fun challenge :)
Changed the readme to make it look a little fancier
2018-11-01 06:11:11 +00:00
<hr>
Fixed a formatting issue with a title Had to add an extra space between <hr> and ## How to use, the previous commit messed up the formatting
2018-11-01 20:10:34 +00:00
Fix README formatting
2017-10-22 03:58:02 +00:00
## How to use
* lay base for 3D engine * add failure reporting to Init functions, and DeInit functions * GPU-related notes * readme update
2017-02-07 21:23:46 +00:00
insert wacky commit message
2022-03-08 11:03:16 +00:00
Firmware boot (not direct boot) requires a BIOS/firmware dump from an original DS or DS Lite.
wifi: proper TX/RX status switch and RX check readme: little update
2017-06-15 19:41:18 +00:00
DS firmwares dumped from a DSi or 3DS aren't bootable and only contain configuration data, thus they are only suitable when booting games directly.
Fix README formatting
2017-10-22 03:58:02 +00:00
### Possible firmware sizes
* allow 128KB firmwares (DSi/3DS dumps) * document firmware sizes better
2017-08-05 17:13:55 +00:00
* 128KB: DSi/3DS DS-mode firmware (reduced size due to lacking bootcode)
* 256KB: regular DS firmware
* 512KB: iQue DS firmware
guess this is good for 0.7. readme update as a pretext
2018-10-26 19:06:46 +00:00
DS BIOS dumps from a DSi or 3DS can be used with no compatibility issues. DSi BIOS dumps (in DSi mode) are not compatible. Or maybe they are. I don't know.
* lay base for 3D engine * add failure reporting to Init functions, and DeInit functions * GPU-related notes * readme update
2017-02-07 21:23:46 +00:00
maybe this shit will finally work. also update the README.
2017-03-29 20:56:30 +00:00
As for the rest, the interface should be pretty straightforward. If you have a question, don't hesitate to ask, though!
* somewhat proper event scheduler * support for timers * fixes, additions, shit
2016-12-05 16:08:24 +00:00
Fix README formatting
2017-10-22 03:58:02 +00:00
## How to build
Use Qt 6 by default on all platforms and update build instructions (#2187)
2024-11-05 16:03:07 +00:00
See [BUILD.md](./BUILD.md) for build instructions.
Add support for macOS (#771) * use shm_open() instead of memfd_create() on macOS malloc.h isn't a header on macOS * Change OpenGL headers + create ifdef for DO_PROCLIST macOS seems to already have the OpenGL functions defined, without the ifdef, it gives "ambiguous references" errors. * macOS doesn't have ->gregs in uc_mcontext and it doesn't have REG_RIP either https://github.com/gperftools/gperftools/blob/master/m4/pc_from_ucontext.m4 * use getpid() to make memory file name unique * #ifndef __APPLE__ for AF_PACKET and linux/if_packet.h * Add include and link directories for macOS and link the OpenGL framework * Add macOS CI * Use newly added libslirp package from Homebrew https://github.com/Homebrew/homebrew-core/pull/63412 * Use Apple's Clang instead of GNU GCC on macOS * Add macOS build instructions to README * Try to fix macOS undefined symbol * snprintf doesn't take null terminator into account * Map new memory on macOS for JIT * Only use gcc-ar if using GNU Compiler * re-add fastmem code - whoops! * Fix style issue - use camelCase not snake_case * Set Minimum macOS version * Switch Minimum OS X version to 10.9 * Add macOS libpcap library name * fix memory leak * Fix binding keys in macOS * Allow getting MAC address on macOS melonDS on Linux uses AF_PACKET, which doesn't exist on macOS. Instead, this commit uses AF_LINK on macOS to get the MAC address. * Remove unneeded macOS CI dependencies * Build melonDS app bundle on macOS Now it is no longer required to install the libraries on macOS, they come with the app bundle. * fix macOS CI not being able to find macdeployqt * copy melonDS.app with recursive because it's a folder * Disable fastmem checkbox on macOS * Disable fastmem by default in config * forgot a semicolon * Don't bundle libraries, causes issues on macOS <10.15 * Update README + allow finding version in Finder on macOS * Make sure fastmem checkbox stays uncheckable
2020-11-29 16:11:33 +00:00
Fix README formatting
2017-10-22 03:58:02 +00:00
## TODO LIST
* somewhat proper event scheduler * support for timers * fixes, additions, shit
2016-12-05 16:08:24 +00:00
update the TODO lists
2022-03-06 19:16:58 +00:00
* better DSi emulation
* better OpenGL rendering
BAHAHAHAHAHAJSKASLASJISFS--+|*~+-.
2022-11-03 19:35:21 +00:00
* netplay
BAHAHHAHAHAHH
2019-06-12 12:03:06 +00:00
* the impossible quest of pixel-perfect 3D graphics
guess this is good for 0.7. readme update as a pretext
2018-10-26 19:06:46 +00:00
* support for rendering screens to separate windows
readme update
2017-08-29 16:17:44 +00:00
* emulating some fancy addons
update the TODO lists
2022-03-06 19:16:58 +00:00
* other non-core shit (debugger, graphics viewers, etc)
Changed the readme to make it look a little fancier
2018-11-01 06:11:11 +00:00
update the TODO lists
2022-03-06 19:16:58 +00:00
### TODO LIST FOR LATER (low priority)
* fix GXFIFO decoding * proper SwapBuffers implementation * fix polygon clipping * misc fixes
2017-02-13 01:07:54 +00:00
start work on polygon edges and shit
2017-03-12 23:45:26 +00:00
* big-endian compatibility (Wii, etc)
* LCD refresh time (used by some games for blending effects)
maybe this shit will finally work. also update the README.
2017-03-29 20:56:30 +00:00
* any feature you can eventually ask for that isn't outright stupid
Changed the readme to make it look a little fancier
2018-11-01 06:11:11 +00:00
Fix README formatting
2017-10-22 03:58:02 +00:00
## Credits
readme update
2017-08-29 16:17:44 +00:00
* Martin for GBAtek, a good piece of documentation
* Cydrak for the extra 3D GPU research
add credit for the icon
2020-04-14 21:32:47 +00:00
* limittox for the icon
readme update
2017-08-29 16:17:44 +00:00
* All of you comrades who have been testing melonDS, reporting issues, suggesting shit, etc
Changed the readme to make it look a little fancier
2018-11-01 06:11:11 +00:00
Redesign the Input dialog (#1226)
2021-09-30 17:23:25 +00:00
## Licenses
Changed the readme to make it look a little fancier
2018-11-01 06:11:11 +00:00
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)
melonDS 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 3 of the License, or
Use libepoxy to load in OpenGL functions (#960) * Use libepoxy to load in OpenGL functions Prevents having to load them in manually * Install libepoxy in the CI * Do not link OpenGL libraries, libepoxy opens them itself * Add libepoxy to build instructions
2021-01-26 13:19:32 +00:00
(at your option) any later version.
Redesign the Input dialog (#1226)
2021-09-30 17:23:25 +00:00
### External
* Images used in the Input Config Dialog - see `src/frontend/qt_sdl/InputConfig/resources/LICENSE.md`