VNDS-LOVE 3DS: Difference between revisions

From GameBrew
(Created page with "{{Infobox 3DS homebrew | title = VNDS-LOVE | image = https://dlhb.gamebrew.org/3dshomebrew/VNDS-LOVE.jpg|250px | type = Other Apps | version = v0.0.11 | licence = Mixed | auth...")
 
No edit summary
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Infobox 3DS homebrew
{{Infobox 3DS Homebrews
| title = VNDS-LOVE
|title=VNDS-LOVE
| image = https://dlhb.gamebrew.org/3dshomebrew/VNDS-LOVE.jpg|250px
|image=Vndslove2.png
| type = Other Apps
|description=VNDS for the 3DS (WIP).
| version = v0.0.11
|author=ajusa
| licence = Mixed
|lastupdated=2023/02/12
| author = ajusa
|type=Game engine
| website = https://github.com/ajusa/VNDS-LOVE
|version=0.0.13
| download = https://dlhb.gamebrew.org/3dshomebrew/VNDS-LOVE.rar
|license=Mixed
| source = https://dlhb.gamebrew.org/3dshomebrew/VNDS-LOVE.rar
|download=https://dlhb.gamebrew.org/3dshomebrews/vndslove3ds.7z
|website=https://github.com/ajusa/VNDS-LOVE
|source=https://github.com/ajusa/VNDS-LOVE
|donation=https://ko-fi.com/ajusa
}}
}}
<youtube>PoImIj0ZJj8</youtube>
VNDS-LOVE is a cross platform program that plays [[VNDS|Visual Novel Dual Screen]] formatted novels. Windows, Mac, Linux, and the [[VNDS-LOVE Switch|Nintendo Switch]] are all fully supported (note that you need to have a Switch capable of running homebrew).


<img src="icons/icon.jpg?raw=true" width="128" height=128>
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 capabilities of newer visual novels. They support basic audio and image based storytelling.
# VNDS-LOVE
 
[![Build Status](https://github.com/ajusa/VNDS-LOVE/workflows/VNDS-LOVE/badge.svg)](https://github.com/ajusa/VNDS-LOVE/actions)
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.
[![Discord](https://img.shields.io/discord/716444798432575518.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/q8wjpt2)
 
[![Guide](https://img.shields.io/badge/View-Guide-blue)](https://docs.google.com/document/d/e/2PACX-1vRoZeD_wTko3X7FnARS2HtUerTUABwqnfnEJQpuEG9GQ0UvbnWFdbhvg7eEYsFNnMxTUJ7F9dupMCjQ/pub)
'''Note:''' Many of the original sources for the VNDS no longer exist, but you can find further information on it at [https://github.com/BASLQC/vnds/wiki VNDS Wiki].
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.
==Known issues==
## What is VNDS?
Only partially supported on 3DS. See [https://github.com/ajusa/VNDS-LOVE/issues/16 this issues].
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 [at this wiki page.](https://github.com/BASLQC/vnds/wiki)
 
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.
==Changelog==
## Project Status
'''v0.0.13'''
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.
*Fixes a bug ([https://github.com/ajusa/VNDS-LOVE/issues/37 #37]) related to font resizing when drawing the option menu (thank you @snuk182 for reporting and fixing the issue!)
## Supported Platforms
 
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.12'''
### Nintendo 3DS
* Fixes a bug ([https://github.com/ajusa/VNDS-LOVE/issues/35 #35]) related to text interpolation that was used in certain novels.
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.
* Fixed an issue with loading zipped folders on the 3DS platform, thanks @TurtleP for helping me debug that.
Performance on the 3DS is also lacking at this moment. You can see this being tracked in [this issue.](https://github.com/ajusa/VNDS-LOVE/issues/16)
 
### Android
'''v0.0.11'''
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.
* Fixed an issue reported by Mishima on Discord that was causing listbox to fail.
# Installation Instructions
* Better error handling for when a file isn't found.
If you are a **user** who wants to install this, go to the guide [here](https://docs.google.com/document/d/e/2PACX-1vRoZeD_wTko3X7FnARS2HtUerTUABwqnfnEJQpuEG9GQ0UvbnWFdbhvg7eEYsFNnMxTUJ7F9dupMCjQ/pub).
* Might fix [https://github.com/ajusa/VNDS-LOVE/issues/33#issuecomment-798838970 #33 (comment)], haven't testing on Switch personally yet.
If you encounter any issues, feel free to pop in our Discord [here.](https://discord.gg/q8wjpt2)
 
If you don't want to use Discord for some reason, feel free to open a Github issue.
'''v0.0.10'''
## Having an Issue?
* Tried to fix audio crashing bug in [https://github.com/ajusa/VNDS-LOVE/issues/31 #31].
Go to the [issues](https://github.com/ajusa/VNDS-LOVE/issues/) and search for an issue similar to yours.
* Changed default rescaling to use linear as suggested in [https://github.com/ajusa/VNDS-LOVE/issues/32 #32].
If there are no similar issues, go ahead and make a new one! Fill out as much information as you can.
* Trying to make sure that the font can't be nil at runtime to fix [https://github.com/ajusa/VNDS-LOVE/issues/33 #33].
# Development Instructions
 
ONLY FOLLOW THESE INSTRUCTIONS IF YOU WANT TO COMPILE VNDS-LOVE!
'''v0.0.9'''
IF YOU JUST WANT TO PLAY VISUAL NOVELS, GO TO THE GUIDE!
* Added a settings menu
**Note:** Right now, building an NRO file is only supported on systems that you can install devKitPro on.
** You can change values by using the left/right buttons, such as the audio/music percent.
You can still easily test, but you won't be able to generate a final package.
* Can change the audio settings for both music and sounds, closing [https://github.com/ajusa/VNDS-LOVE/issues/22 #22].
You should be able to develop on Windows, Mac, and Linux. If you encounter any errors when trying to do that, [create an issue.](https://github.com/ajusa/VNDS-LOVE/issues/new)
* Tries to use the default.ttf if it is provided in a novel, closing [https://github.com/ajusa/VNDS-LOVE/issues/25 #25].
## Quickstart
** This can be overidden in the settings.
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.
* Fixed an issue with being able to close the save menu.
## Guide
 
1. Install [LuaRocks](https://luarocks.org/)
'''v0.0.8'''
2. After making sure that LuaRocks is on your path (`luarocks --help` has output), run the following:
* 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.
luarocks install moonscript
* Ability to quit from within VNDS-LOVE! Open menu and then select quit.
luarocks install busted
 
luarocks install alfons
'''v0.0.7'''
```
* Use the mime type of a file to decide how to open it (fixes Kanon).
3. Clone the repository (`git clone https://github.com/ajusa/VNDS-LOVE`)
 
4. `cd` to the cloned directory (`cd VNDS-LOVE`)
[https://github.com/ajusa/VNDS-LOVE/releases Release notes.]
5. Install [Love2D](https://love2d.org/) and make sure it is also on your path.
 
Run `alfons compile` to compile the moonscript source to lua.
==External links==
Run `alfons run` to run VNDS-LOVE using the installed copy of `love`.
* GitHub - https://github.com/ajusa/VNDS-LOVE
Run `alfons test` to run the busted unit tests, which are located in `spec`
* Reddit - https://www.reddit.com/r/3dshacks/comments/kmtmi0/wip_running_vnds_fatestay_night_on_a_2ds
## Building
* Discord - https://discord.gg/q8wjpt2
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.
[[Category:3DS homebrew applications]]
You can submit a [Pull Request](https://github.com/ajusa/VNDS-LOVE/pulls) without building the program.
[[Category:Other 3DS homebrew applications]]
Building is just for distribution.
[[Category:Support the author]]
With that out of the way:
### Building for Windows, Mac, and Linux
1. Try running `luarocks install --server=http://luarocks.org/dev love-release`
2. Install `libzip-dev` on your OS if the above command fails.
3. Run `alfons build`, and the build files should appear in a `build` folder, including a `.love` 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 [here](https://turtlep.github.io/LovePotion/wiki/#/building).
1. Install [lovebrew](https://github.com/TurtleP/lovebrew) and make sure you can run `lovebrew -h`
2. Create a directory called `bin` in the root of the project
3. Download the latest [LovePotion release](https://github.com/TurtleP/LovePotion/releases), and save `LovePotion.elf` in `bin/switch.elf`.
4. Run `lovebrew` in the project directory.
This should output a `VNDS-LOVE.nro` file in the project root directory to test with.

Latest revision as of 09:12, 1 February 2024

VNDS-LOVE
Vndslove2.png
General
Authorajusa
TypeGame engine
Version0.0.13
LicenseMixed
Last Updated2023/02/12
Links
Download
Website
Source
Support Author

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 capabilities 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.

Note: Many of the original sources for the VNDS no longer exist, but you can find further information on it at VNDS Wiki.

Known issues

Only partially supported on 3DS. See this issues.

Changelog

v0.0.13

  • Fixes a bug (#37) related to font resizing when drawing the option menu (thank you @snuk182 for reporting and fixing the issue!)

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=143433’

Advertising: