Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upload of vnds-love novel engine #1229

Merged
merged 4 commits into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions ports/vnds-love/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Port of VNDS-LOVE Engine
VNDS is a standard for very simple and easy to use Visual Novel scripts. It was originally developed for the Nintendo DS.
This port allows you to play such famous games as Tsukihime, Fate \ Stay night, Ever 17, Saya no Uta and many others.

## Controls

| Button | Action |
|--|--|
|A|Confirm/Next|
|B|Cancel/Back|
|X|Skip to Next Choice|
|Y|Fast Forward Text|
|D-Pad (Up) |Navigation (View Previous Text)|
|Start|Toggle Menu|

## What is this?
This is a port of VNDS-LOVE (https://github.com/ajusa/VNDS-LOVE) for linux based handhelds that support Portmaster project (https://portmaster.games/).
Port does not include any VNDS visual novels but these are extremely easy to procure. More info about finding these can be found on the [VNDS wiki](https://github.com/BASLQC/vnds/wiki).
## How do I use it?
Place your novel folder into
```
./vnds-love/conf/love/VNDS-LOVE/novels/
```

<details>
<summary>example of folder structure</summary>

```bash
└── novels
├── ever17
│   ├── background
│   ├── default.ttf
│   ├── foreground
│   ├── icon-high.png
│   ├── icon.png
│   ├── img.ini
│   ├── info.txt
│   ├── script
│   ├── sound.zip
│   ├── thumbnail-high.jpg
│   └── thumbnail.png
└── Tsukihime
├── background.zip
├── ChangeLog
├── default.ttf
├── foreground.zip
├── icon.png
├── img.ini
├── info.txt
├── save1.json
├── script.zip
├── sound.zip
└── thumbnail.png
```
</details>

then run the port and use internal launcher to select novel.

## Thanks To
VNDS-LOVE project https://github.com/ajusa/VNDS-LOVE for porting the engine to love2d.
@JanTrueno for giving references on how to port love2d projects to Portmaster.
@StockPainter for motivating me, testing results and supporting with other project`s stuff.
And thanks to all Portmaster community for provided tools and documentation.

40 changes: 40 additions & 0 deletions ports/vnds-love/VNDS.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#!/bin/bash

XDG_DATA_HOME=${XDG_DATA_HOME:-$HOME/.local/share}

if [ -d "/opt/system/Tools/PortMaster/" ]; then
controlfolder="/opt/system/Tools/PortMaster"
elif [ -d "/opt/tools/PortMaster/" ]; then
controlfolder="/opt/tools/PortMaster"
elif [ -d "$XDG_DATA_HOME/PortMaster/" ]; then
controlfolder="$XDG_DATA_HOME/PortMaster"
else
controlfolder="/roms/ports/PortMaster"
fi

source $controlfolder/control.txt

[ -f "${controlfolder}/mod_${CFW_NAME}.txt" ] && source "${controlfolder}/mod_${CFW_NAME}.txt"

get_controls

GAMEDIR=/$directory/ports/vnds-love
CONFDIR="$GAMEDIR/conf/"

mkdir -p "$GAMEDIR/conf"
cd $GAMEDIR

> "$GAMEDIR/log.txt" && exec > >(tee "$GAMEDIR/log.txt") 2>&1

# Set the XDG environment variables for config & savefiles
export XDG_DATA_HOME="$CONFDIR"
export SDL_GAMECONTROLLERCONFIG="$sdl_controllerconfig"

source $controlfolder/runtimes/"love_11.5"/love.txt

# Run the love runtime
$GPTOKEYB "$LOVE_GPTK" &
pm_platform_helper "$LOVE_BINARY"
$LOVE_RUN "$GAMEDIR/vnds.love"

pm_finish
12 changes: 12 additions & 0 deletions ports/vnds-love/gameinfo.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<gameList>
<game>
<path>./VNDS.sh</path>
<name>VNDS Novel Reader</name>
<desc>VNDS-LOVE is a cross platform program that plays Visual Novel Dual Screen formatted novels. Many famous visual novels have been ported to this format, which was designed for the Nintendo DS.</desc>
<releasedate>20201230T000000</releasedate>
<developer>Arham Jain</developer>
<genre>visual novel</genre>
<image>./vnds-love/screenshot.png</image>
</game>
</gameList>
31 changes: 31 additions & 0 deletions ports/vnds-love/port.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"version": 3,
"name": "vnds-love.zip",
"items": [
"VNDS.sh",
"vnds-love"
],
"items_opt": [],
"attr": {
"title": "VNDS Novel Reader",
"porter": [
"ddrsoul"
],
"desc": "VNDS-LOVE allows you to play such famous games as Tsukihime, Fate \\ Stay night, Ever 17, Saya no Uta and many others.",
"desc_md": null,
"inst": "Check VNDS Wiki \"https://github.com/BASLQC/vnds/wiki\" to find VNDS ready novels. Place your novel folder into ./vnds-love/conf/love/VNDS-LOVE/novels/ \nMore info in README.",
"inst_md": null,
"genres": [
"visual novel"
],
"image": null,
"rtr": false,
"exp": false,
"runtime": null,
"reqs": [],
"arch": [
"aarch64"
],
"min_glibc": ""
}
}
Binary file added ports/vnds-love/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
width=640
height=480
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
text engine VNDS-LOVE by Arham Jain (ajusa)
text port by ddrsoul
text Thanks to all Portmaster Community!
jump main2.scr
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
bgload sunset.jpg
text @VNDS Tutorial
text @-------------
text for Portmaster VNDS-LOVE port
text This port is meant to play VNDS ready novels.
text List of most popular novels, avalable as VNDS package is:
text Tsukihime, Fate\Stay night, Ever17, Higurashi, Umineko, Cross Channel and many many others.
text This port does not contain any visual novels, but you can learn ways to obtain them at wiki:
text https://github.com/BASLQC/vnds/wiki
text Unpack archive into
text ./vnds-love/conf/love/VNDS-LOVE/novels/
text and run the game from main menu.
text For additional info check README on portmaster.games.
jump main2.scr
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
choice Repeat Again|Credits
if selected == 1
jump main.scr
fi
if selected == 2
jump credits.scr
Loading