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: docs/library/fbneo.md
+42-15Lines changed: 42 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ Note : Here is a non-exhaustive list of additional parameters you might want to
62
62
63
63
## Building romsets for FBNeo
64
64
65
-
Arcade emulation won't work properly without the romsets matching the emulator. FBNeo being an emulator under active development, a given romset might change from time to time to stay in sync with the best dump available for that game.
65
+
You won't be able to emulate games without the romsets matching this emulator. FBNeo being an emulator under active development, a given romset might change from time to time to stay in sync with the best dump available for that game.
66
66
67
67
Don't expect things to work properly if you didn't build valid romsets, and don't report issues because your romsets are invalid.
68
68
@@ -74,6 +74,7 @@ You can download the dat files for the latest version of the core from the [dats
74
74
75
75
It mostly consists of latest dumps available for MAME.
76
76
The other romsets are usually a mix of hacks and homebrews, most of them can be found in HBMAME dumps.
77
+
Console/computer romsets come from different sources (recently emulated systems are likely to be based on No-Intro, but older ones were mostly based on MESS, there are also a lot of hacks/homebrews you won't find in those sets).
77
78
Having an older FBAlpha/FBNeo set among your ingredients will also help a lot.
78
79
79
80
### Step 3: Building the romsets
@@ -128,7 +129,7 @@ The following device types are mostly WIP, they haven't been thoroughly tested a
128
129
129
130
## Emulating consoles and computers
130
131
131
-
It also requires usage of specific romsets, meaning the rom must have the expected crc/size, and be packaged in an archive with a specific name (the instructions to build those romsets don't differ from arcade's).
132
+
It also requires usage of specific romsets, meaning the rom must have the expected crc/size, and be packaged in an archive with a specific name ([the instructions to build those romsets aren't different from arcade](#building-romsets-for-fbneo)).
132
133
133
134
You can use specific folder's name for detection, it's the easiest and recommended method, especially if you are using RetroArch playlists or if your device is not compatible with subsystems (android and consoles) :
134
135
@@ -223,13 +224,15 @@ Here is a list of samples currently in use :
@@ -260,11 +263,13 @@ Here is a list of samples currently in use :
260
263
| seawolf ||
261
264
| sfz3mix | Not from MAME, optional, replace OG music by HQ music, no dipsw. |
262
265
| sharkatt ||
266
+
| sidetrac | Not from MAME |
263
267
| sot4w | Not from MAME, megadrive |
264
268
| spacefb ||
265
269
| spacfury ||
266
270
| stinger | Not from MAME |
267
271
| subroc3d ||
272
+
| targ ||
268
273
| thehand ||
269
274
| thief ||
270
275
| tr606drumkit | Not from MAME |
@@ -278,7 +283,7 @@ Here is a list of samples currently in use :
278
283
279
284
## Hiscores
280
285
281
-
Copy [hiscore.dat](https://github.com/libretro/FBNeo/raw/master/metadata/hiscore.dat) to `SYSTEM_DIRECTORY/fbneo/` and have the hiscore core option enabled.
286
+
Copy [hiscore.dat](https://github.com/libretro/FBNeo/raw/master/metadata/hiscore.dat) to `SYSTEM_DIRECTORY/fbneo/` and have `Quick Menu > Core Options > Hiscores` enabled.
282
287
283
288
It doesn't guarantee hiscores will work for a specific game though, sometimes a driver could just be missing the necessary support code for this feature, or `hiscore.dat` might have a missing or broken entry for that romset. You can request support in the issue tracker.
284
289
@@ -298,15 +303,15 @@ This core provides support for RetroAchievements, and some were added for popula
298
303
299
304
## Dipswitches
300
305
301
-
They are either directly available from `Quick Menu > Core Options`, or from the service menu after setting its shortcut in the `Diagnostic Input` core option.
306
+
They are either directly available from `Quick Menu > Core Options > DIP Switches`, or from the service menu after setting its shortcut at `Quick Menu > Core Options > Diagnostic Input`.
302
307
303
308
## Cheats
304
309
305
310
This core supports the RetroArch cheat feature with the `.cht` files. However it is recommended to use FBNeo's native cheat support instead :
306
311
307
312
* Download the pack of cheats from [here](https://github.com/finalburnneo/FBNeo-cheats/archive/master.zip)
308
313
* Uncompress **all of them** into the `SYSTEM_DIRECTORY/fbneo/cheats/` folder (which is **NOT** the same folder as the RetroArch feature with the `.cht` files)
309
-
* Cheats will become available through core options (`Quick Menu > Core Options`, **NOT**`Quick Menu > Cheats`) afterward.
314
+
* Cheats will become available through core options (`Quick Menu > Core Options > Cheat`, **NOT**`Quick Menu > Cheats`) afterward.
310
315
311
316
## Multi-language
312
317
@@ -325,18 +330,26 @@ As far as we are concerned, you are supposed to dump your own games, so we can't
325
330
326
331
If present, the line `Verify the following romsets : <romset> <parent> <bios>` gives you the list of split romsets required by the game you are trying to run. This is mainly for reference since you might not be striving to use romsets in split format. The next few lines give you the list of files it couldn't find within those romsets.
327
332
328
-
Otherwise, a `Romset is unknown` message means the romset couldn't be found by its filename in our database.
333
+
Otherwise, a `Romset is unknown` message means the romset couldn't be found by its filename in our database, meaning it's either not supported at all or wrongly named.
329
334
330
335
Both problems result from not reading the [arcade documentation](https://docs.libretro.com/guides/arcade-getting-started/#step-3-use-the-correct-version-romsets-for-that-emulator).
331
336
Exceptionally there might be false positives due to your files being unreadable for some reason (file corruption during transfer, file permission, damaged disk drive, [retroarch regression](https://github.com/libretro/RetroArch/issues/18582), ...). This is usually a rabbit hole and something you should only concern yourself after using clrmamepro to verify your romsets.
332
337
333
338
Rarely you could get a "Failed initializing driver" message, this is something you should report [here](https://github.com/finalburnneo/FBNeo/issues)
334
339
340
+
### Is XXX supported ?
341
+
342
+
You can check the [dats](https://github.com/libretro/FBNeo/tree/master/dats/) or [gamelist.txt](https://raw.githubusercontent.com/libretro/FBNeo/refs/heads/master/gamelist.txt) to see if a game is supported.
343
+
344
+
We don't accept requests for supporting a game, and questions regarding the lack of support for a game are also regarded as requesting for its support.
345
+
One exception to that rule would be for consoles/computers we already support, and you should make that request [here](https://neo-source.com/index.php?topic=3656.0).
346
+
Games running on already emulated arcade systems will also be tolerated, the most common case for this would be romhacks of already emulated games, don't ask if you are not absolutely sure.
347
+
335
348
### How can i run that romhack i found ?
336
349
337
350
A lot of romhacks are supported natively, so your romhack might already be supported under a specific romset name.
338
351
339
-
For the unsupported romhacks, there are 3 methods, but those romhacks are not allowed and must be disabled by toggling off the `Allow patched romsets` core option if you intend to use RetroAchievements :
352
+
For the unsupported romhacks, there are 3 methods, but those romhacks are not allowed if you intend to use RetroAchievements and must be disabled by toggling off `Quick Menu > Core Options > Allow patched romsets` :
340
353
341
354
#### Using the "patched" folder
342
355
@@ -346,13 +359,13 @@ For the unsupported romhacks, there are 3 methods, but those romhacks are not al
346
359
#### Using IPS Patches
347
360
348
361
* Put all IPS patch files (including: driver name directory/**.dat|**.ips) into the `SYSTEM_DIRECTORY/fbneo/ips/` folder.
349
-
* IPS Patch will become available through core options (`Quick Menu > Core Options`) afterward. To apply them, you need to launch the game, enable them in core options, then use RetroArch's "restart" action.
362
+
* IPS Patch will become available through core options (`Quick Menu > Core Options > IPS Patch`) afterward. To apply them, you need to launch the game, enable them in core options, then use RetroArch's "restart" action.
350
363
* Note : To avoid competing with loaded games for startup privileges, IPS Patches is initially disabled by default.
351
364
352
365
#### Using RomData
353
366
354
367
* Put all RomData files (including: driver name directory/**.dat) into the `SYSTEM_DIRECTORY/fbneo/romdata/` folder
355
-
* RomData will become available through core options (`Quick Menu > Core Options`) afterward. To apply them, you need to launch the game, enable them in core options, then use RetroArch's "restart" action.
368
+
* RomData will become available through core options (`Quick Menu > Core Options > RomData`) afterward. To apply them, you need to launch the game, enable them in core options, then use RetroArch's "restart" action.
356
369
357
370
Please note that all 3 methods still require that you launch the original non-patched romset, it will be patched/replaced at runtime.
358
371
@@ -409,11 +422,11 @@ You can convert your unsupported dumps by following this tutorial :
409
422
410
423
### Why can't i launch Killer instinct ? I heard it's supported.
411
424
412
-
That driver was disabled for now, it didn't meet our quality criteria.
425
+
That driver was disabled, it didn't meet our quality criteria. There are no plans for fixing it at the moment.
413
426
414
427
### Where is the hires dipswitch on vector games ? It seems gone.
415
428
416
-
It was streamlined into a global `Resolution` core option affecting all vector games at once, with new resolutions available.
429
+
It was streamlined into a global `Video Settings > Resolution` core option affecting all vector games at once, with new resolutions available.
417
430
418
431
For best visual results, it's recommended to match your screen's height, some examples using a 1080p screen :
419
432
* for horizontal games, you'll want to use 1440x1080
@@ -431,7 +444,7 @@ If you are wondering why this isn't required for the MAME core, you can find mor
431
444
432
445
Additionally :
433
446
434
-
* If you are playing on a vertical screen, you'll want to use the `Vertical Mode` core option to rotate the display for your needs, it should also be possible to rotate display from `Settings > Video > Output > Video Rotation` but that method might handle the aspect ratio incorrectly.
447
+
* If you are playing on a vertical screen, you'll want to use the `Video Settings > Vertical Mode` core option to rotate the display for your needs, it should also be possible to rotate display from `Settings > Video > Output > Video Rotation` but that method might handle the aspect ratio incorrectly.
435
448
* If you are using a bezel pack, make sure it's compatible with FBNeo (apparently, some were written specifically to work with MAME's internal rotation) and to follow its official instructions. In some case it seems enabling `Settings > On-Screen Display > On-Screen Overlay > Auto-Scale Overlay` (`input_overlay_auto_scale = "true"` in `retroarch.cfg`) can help.
436
449
437
450
### Why is the music high-pitched, too fast and/or different from what i think it should be ?
@@ -441,12 +454,12 @@ The first question you should be asking yourself is "what am i comparing this to
441
454
If you are comparing this to FBNeo standalone, you must be warned that the libretro port is using different default audio settings.
442
455
By default standalone has 44100 samplerate and both interpolations off, and that's what you should set in core options if you want the same audio output.
443
456
444
-
Last but not least, you might also want to make sure you are running the game at the correct speed, most crt games don't run at 60Hz and if you want the proper refresh rate to be emulated you'll need to make sure `Force 60Hz` isn't enabled in core options and `Settings > Video > Synchronization > Sync to Exact Content Framerate` is enabled (`vrr_runloop_enable = "true"` in `retroarch.cfg`).
457
+
Last but not least, you might also want to make sure you are running the game at the correct speed, most crt games don't run at 60Hz and if you want the proper refresh rate to be emulated you'll need to make sure `Video Settings > Force 60Hz` isn't enabled in core options and `Settings > Video > Synchronization > Sync to Exact Content Framerate` is enabled (`vrr_runloop_enable = "true"` in `retroarch.cfg`).
445
458
Please note that it'll likely cause frame duping if your hardware is not compatible with VRR (Variable Refresh Rate), in which case you'll have to make a choice between animation smoothness and correct refresh rate.
446
459
447
460
### Why do i get a black screen and/or can't i change bios in neogeo games ?
448
461
449
-
The `neogeo` romset is a collection of neogeo bioses, and most of them are considered as optional so they won't cause a "white screen" when missing. Only `MVS Asia/Europe ver. 6 (1 slot)` is mandatory.
462
+
The `neogeo` romset is a collection of neogeo bioses, and most of them are considered optional so they won't cause a "white screen" when missing. Only `MVS Asia/Europe ver. 6 (1 slot)` is mandatory.
450
463
451
464
However, having an incomplete romset can still cause various issues :
452
465
@@ -486,7 +499,21 @@ NVRAM/EEPROM are saved in the `SAVEFILES_DIRECTORY/fbneo` folder, and you can ge
486
499
487
500
### Should i use retroarch's analog-to-digital feature ?
488
501
489
-
You should **NEVER** use that feature with this core, it already converts analog to digital and digital to analog internally. Exceptionally it might not do that conversion because each of those controls are already doing their own thing.
502
+
You should **NEVER** use that feature with this core, it already converts analog to digital and digital to analog internally. Exceptionally it might not do that conversion because each of those controls are already doing their own thing, meaning you don't want that conversion either.
503
+
504
+
### Why is my old savestate not working anymore after updating my core ?
505
+
506
+
A core's savestates are only guaranteed to keep working as long as you NEVER update that core.
507
+
Savestates are tied to how a game is emulated, and updating a core might significantly change how that game is emulated, breaking older savestates in the process.
508
+
This does apply to any core, but is likely to be more frequent for actively developed multi-system emulators like FBNeo.
509
+
You should be wary of updating your cores if this is a major concern for you.
510
+
Note that rollback netplay with mismatching core versions can also be affected by this.
511
+
512
+
### Why am i having trouble playing with a keyboard ?
513
+
514
+
Keyboards, especially cheaper ones, are often affected by ghosting, which will prevent some key combinations from working and hinder your experience. You can test your keyboard [here](https://www.microsoft.com/applied-sciences/projects/anti-ghosting-demo).
515
+
516
+
Additionally, keyboards are kind of unsuitable for arcade emulation, because they allow things that were impossible on real hardware, like pressing opposite directions. This commonly leads to problems while doing special moves involving opposite directions in fighting games. The FBNeo core has a core option at `Input Settings > SOCD Mode` to mitigate this, and some value might work better than another for your play style.
0 commit comments