VNDS-LOVE 3DS: Difference between revisions

From GameBrew
No edit summary
No edit summary
Line 2: Line 2:
|title=VNDS-LOVE
|title=VNDS-LOVE
|image=VNDS-LOVE.jpg
|image=VNDS-LOVE.jpg
|description=VNDS-LOVE is a cross platform program that plays Visual Novel Dual Screen formatted novels.
|description=VNDS for the 3DS (WIP).
|author=ajusa
|author=ajusa
|lastupdated=2021/05/12
|lastupdated=2021/05/12
Line 12: Line 12:
|source=https://github.com/ajusa/VNDS-LOVE
|source=https://github.com/ajusa/VNDS-LOVE
}}
}}
<youtube>PoImIj0ZJj8</youtube>
VNDS-LOVE is a cross platform program that plays Visual Novel Dual Screen formatted novels. Windows, Mac, Linux, and the Nintendo Switch are all fully supported (note that you need to have a Switch capable of running homebrew).


VNDS-LOVE is a cross platform program that plays '''V'''isual '''N'''ovel '''D'''ual '''S'''creen formatted novels. Many famous visual novels have been ported to this format, which was designed for the Nintendo DS.
VNDS is a specification designed for visual novels in order to run them on the Nintendo DS. Many famous visual novels have been ported to this format, which only have a few commands. As such, they don’t have any support for animations, videos, or other fancier graphical capabilites of newer visual novels. They support basic audio and image based storytelling.


== What is VNDS? ==
For Nintendo 3DS, it is only partially supported and a work in progress. At the moment the image format that the 3DS needs is custom (.t3x) so PNG/JPG files do not work on it without being converted. Text and audio still work fine without any conversion. Performance on the 3DS is also lacking at this moment.


VNDS is a specification designed for visual novels in order to run them on the Nintendo DS. Many of the original sources for the project no longer exist, but you can find further information on it [https://github.com/BASLQC/vnds/wiki at this wiki page.]
==Installation==
3DSX build is available, note that image format needs to be .t3x.


VNDS novels only have a few commands. As such, they don’t have any support for animations, videos, or other fancier graphical capabilites of newer visual novels. They support basic audio and image based storytelling.
VNDS-LOVE [https://docs.google.com/document/d/e/2PACX-1vRoZeD_wTko3X7FnARS2HtUerTUABwqnfnEJQpuEG9GQ0UvbnWFdbhvg7eEYsFNnMxTUJ7F9dupMCjQ/pub#h.woxt4rl38n3t installation guide].


== Project Status ==
==User guide==
Many of the original sources for the project no longer exist, but you can find further information on it [https://github.com/BASLQC/vnds/wiki at this wiki page].


Mostly functional. There are no known VNDS related bugs. Note that some features from other visual novel engines might be missing. If they are, file an issue along with a general description of the feature.
==Known issues==
Only partially supported on 3DS. See [https://github.com/ajusa/VNDS-LOVE/issues/16 this issues].


== Supported Platforms ==
==Changelog==
'''v0.0.12'''
* Fixes a bug ([https://github.com/ajusa/VNDS-LOVE/issues/35 #35]) related to text interpolation that was used in certain novels.
* Fixed an issue with loading zipped folders on the 3DS platform, thanks @TurtleP for helping me debug that.


Windows, Mac, Linux, and the Nintendo Switch are all fully supported. Note that you need to have a Switch capable of running homebrew. For more information, see the guide below.
'''v0.0.11'''
* Fixed an issue reported by Mishima on Discord that was causing listbox to fail.
* Better error handling for when a file isn't found.
* Might fix [https://github.com/ajusa/VNDS-LOVE/issues/33#issuecomment-798838970 #33 (comment)], haven't testing on Switch personally yet.


=== Nintendo 3DS ===
'''v0.0.10'''
* Tried to fix audio crashing bug in [https://github.com/ajusa/VNDS-LOVE/issues/31 #31].
* Changed default rescaling to use linear as suggested in [[https://github.com/ajusa/VNDS-LOVE/issues/32 #32].
* Trying to make sure that the font can't be nil at runtime to fix [https://github.com/ajusa/VNDS-LOVE/issues/33 #33].


This is only partially supported and a work in progress. I do provide builds (3dsx files) for the Nintendo 3DS, however the image format that the 3DS needs is custom (.t3x) so PNG/JPG files do not work on it without being converted. At some point I do intend on writing a cross platform conversion tool, however that won’t be for a while most likely. Text and audio still work fine without any conversion.
'''v0.0.9'''
* Added a settings menu
** You can change values by using the left/right buttons, such as the audio/music percent.
* Can change the audio settings for both music and sounds, closing [https://github.com/ajusa/VNDS-LOVE/issues/22 #22].
* Tries to use the default.ttf if it is provided in a novel, closing [https://github.com/ajusa/VNDS-LOVE/issues/25 #25].
** This can be overidden in the settings.
* Fixed an issue with being able to close the save menu.


Performance on the 3DS is also lacking at this moment. You can see this being tracked in [https://github.com/ajusa/VNDS-LOVE/issues/16 this issue.] ### Android Android is also only partially supported. There aren’t any touchscreen controls at this moment. You can still play through novels by hooking up an external gamepad, such as a Switch Joycon over bluetooth or a Wii Remote. Audio, images, and text all work fine.
'''v0.0.8'''
* Added a menu. Access it by hitting the start button on a gamepad, or m(enu) with a keyboard. Close by hitting b (also b on keyboard).
* Save slot support. You can now save and load from up to 10 slots per novel. This number is subject to increase in the future.
* Ability to quit from within VNDS-LOVE! Open menu and then select quit.


== Installation Instructions ==
'''v0.0.7'''
* Use the mime type of a file to decide how to open it (fixes Kanon).


If you are a '''user''' who wants to install this, go to the guide [https://docs.google.com/document/d/e/2PACX-1vRoZeD_wTko3X7FnARS2HtUerTUABwqnfnEJQpuEG9GQ0UvbnWFdbhvg7eEYsFNnMxTUJ7F9dupMCjQ/pub here]. If you encounter any issues, feel free to pop in our Discord [https://discord.gg/q8wjpt2 here.]
[https://github.com/ajusa/VNDS-LOVE/releases Release notes.]


If you don’t want to use Discord for some reason, feel free to open a Github issue.
==External links==
* GitHub - https://github.com/ajusa/VNDS-LOVE
* Reddit - https://www.reddit.com/r/3dshacks/comments/kmtmi0/wip_running_vnds_fatestay_night_on_a_2ds
* Discord - https://discord.gg/q8wjpt2


== Having an Issue? ==
[[Category:3DS homebrew applications]]
 
[[Category:Other 3DS homebrew applications]]
Go to the [https://github.com/ajusa/VNDS-LOVE/issues/ issues] and search for an issue similar to yours. If there are no similar issues, go ahead and make a new one! Fill out as much information as you can.
 
== Development Instructions ==
 
ONLY FOLLOW THESE INSTRUCTIONS IF YOU WANT TO COMPILE VNDS-LOVE! IF YOU JUST WANT TO PLAY VISUAL NOVELS, GO TO THE GUIDE!
 
'''Note:''' Right now, building an NRO file is only supported on systems that you can install devKitPro on. You can still easily test, but you won’t be able to generate a final package.
 
You should be able to develop on Windows, Mac, and Linux. If you encounter any errors when trying to do that, [https://github.com/ajusa/VNDS-LOVE/issues/new create an issue.]
 
== Quickstart ==
 
If you are an experienced developer, try reading through the Dockerfile and the main.yml workflow in the repository to get an idea of how the entire thing is built. If you want step by step instructions, follow along below.
 
== Guide ==
 
# Install [https://luarocks.org/ LuaRocks]
# After making sure that LuaRocks is on your path (<code>luarocks --help</code> has output), run the following:
 
<pre>luarocks install moonscript
luarocks install busted
luarocks install alfons</pre>
<ol start="3" style="list-style-type: decimal;">
<li>Clone the repository (<code>git clone https://github.com/ajusa/VNDS-LOVE</code>)</li>
<li><code>cd</code> to the cloned directory (<code>cd VNDS-LOVE</code>)</li>
<li>Install [https://love2d.org/ Love2D] and make sure it is also on your path.</li></ol>
 
Run <code>alfons compile</code> to compile the moonscript source to lua.
 
Run <code>alfons run</code> to run VNDS-LOVE using the installed copy of <code>love</code>.
 
Run <code>alfons test</code> to run the busted unit tests, which are located in <code>spec</code>
 
== Building ==
 
Building binaries requires additional steps. If you are able to run VNDS-LOVE with changes using Love2D, you do not need to build the program. You can submit a [https://github.com/ajusa/VNDS-LOVE/pulls Pull Request] without building the program. Building is just for distribution.
 
With that out of the way:
 
=== Building for Windows, Mac, and Linux ===
 
# Try running <code>luarocks install --server=http://luarocks.org/dev love-release</code>
# Install <code>libzip-dev</code> on your OS if the above command fails.
# Run <code>alfons build</code>, and the build files should appear in a <code>build</code> folder, including a <code>.love</code> file.
 
=== Building for Switch and 3DS ===
 
Github Actions is set up to do these builds. If you want to do this locally as well, follow the “Dependencies” instructions on the LovePotion wiki [https://turtlep.github.io/LovePotion/wiki/#/building here].
 
# Install [https://github.com/TurtleP/lovebrew lovebrew] and make sure you can run <code>lovebrew -h</code>
# Create a directory called <code>bin</code> in the root of the project
# Download the latest [https://github.com/TurtleP/LovePotion/releases LovePotion release], and save <code>LovePotion.elf</code> in <code>bin/switch.elf</code>.
# Run <code>lovebrew</code> in the project directory.
 
This should output a <code>VNDS-LOVE.nro</code> file in the project root directory to test with.

Revision as of 03:25, 11 December 2021

VNDS-LOVE
File:VNDS-LOVE.jpg
General
Authorajusa
TypeOther Apps
Version0.0.12
LicenseMixed
Last Updated2021/05/12
Links
Download
Website
Source

VNDS-LOVE is a cross platform program that plays Visual Novel Dual Screen formatted novels. Windows, Mac, Linux, and the Nintendo Switch are all fully supported (note that you need to have a Switch capable of running homebrew).

VNDS is a specification designed for visual novels in order to run them on the Nintendo DS. Many famous visual novels have been ported to this format, which only have a few commands. As such, they don’t have any support for animations, videos, or other fancier graphical capabilites of newer visual novels. They support basic audio and image based storytelling.

For Nintendo 3DS, it is only partially supported and a work in progress. At the moment the image format that the 3DS needs is custom (.t3x) so PNG/JPG files do not work on it without being converted. Text and audio still work fine without any conversion. Performance on the 3DS is also lacking at this moment.

Installation

3DSX build is available, note that image format needs to be .t3x.

VNDS-LOVE installation guide.

User guide

Many of the original sources for the project no longer exist, but you can find further information on it at this wiki page.

Known issues

Only partially supported on 3DS. See this issues.

Changelog

v0.0.12

  • Fixes a bug (#35) related to text interpolation that was used in certain novels.
  • Fixed an issue with loading zipped folders on the 3DS platform, thanks @TurtleP for helping me debug that.

v0.0.11

  • Fixed an issue reported by Mishima on Discord that was causing listbox to fail.
  • Better error handling for when a file isn't found.
  • Might fix #33 (comment), haven't testing on Switch personally yet.

v0.0.10

  • Tried to fix audio crashing bug in #31.
  • Changed default rescaling to use linear as suggested in [#32.
  • Trying to make sure that the font can't be nil at runtime to fix #33.

v0.0.9

  • Added a settings menu
    • You can change values by using the left/right buttons, such as the audio/music percent.
  • Can change the audio settings for both music and sounds, closing #22.
  • Tries to use the default.ttf if it is provided in a novel, closing #25.
    • This can be overidden in the settings.
  • Fixed an issue with being able to close the save menu.

v0.0.8

  • Added a menu. Access it by hitting the start button on a gamepad, or m(enu) with a keyboard. Close by hitting b (also b on keyboard).
  • Save slot support. You can now save and load from up to 10 slots per novel. This number is subject to increase in the future.
  • Ability to quit from within VNDS-LOVE! Open menu and then select quit.

v0.0.7

  • Use the mime type of a file to decide how to open it (fixes Kanon).

Release notes.

External links

Retrieved from ‘https://www.gamebrew.org/index.php?title=VNDS-LOVE_3DS&oldid=67399’

Advertising: