Skip to content

Commit fd4068f

Browse files
committed
update readme and prepare for release
1 parent d242da1 commit fd4068f

File tree

9 files changed

+48
-120
lines changed

9 files changed

+48
-120
lines changed

.github/workflows/build_win.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@ jobs:
1919
path: ./thirdparty
2020
key: thirdparty_build
2121

22+
# this should be fixed to download the inital commit thirdparty
2223
- name: download thirdparty_build
2324
if: steps.check_thirdparty_build.outputs.cache-hit != 'true'
2425
run: |
25-
curl -fsSL https://github.com/YuriSizuku/OnscripterYuri/releases/download/v0.7.5beta/thirdparty_build.tar.gz -O
26+
curl -fsSL https://github.com/YuriSizuku/OnscripterYuri/releases/download/v0.6/thirdparty_build.tar.gz -O
2627
tar xvzf thirdparty_build.tar.gz
2728
2829
build_win32:

.github/workflows/build_win_msvc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
name: build windows MSVC x86, x64, ARM64
22
on:
33
push: {tags: ['v*']} # Push events to matching v*, i.e. v1.0, v20.15.10
4+
pull_request:
45

56
permissions:
67
contents: write
@@ -33,7 +34,7 @@ jobs:
3334
run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
3435

3536
- name: Upload artifact
36-
uses: actions/upload-artifact@v2.3.1
37+
uses: actions/upload-artifact@v4
3738
with:
3839
name: onsyuri-${{env.VCPKG_TRIPLET}}
3940
path: ${{github.workspace}}/build/${{env.BUILD_TYPE}}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# general
2+
.vscode/settings.json
23
asset/*test*/**
34
asset/stdout.txt
45
asset/stderr.txt

.vscode/c_cpp_properties.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"name": "Mingw32",
99
"includePath": [
1010
"${workspaceFolder}/src/onsyuri/**",
11+
"${workspaceFolder}/thirdparty/build/arch_mingw32/include/**",
1112
"${msys2sdk}/mingw32/include"
1213
],
1314
"defines": [
@@ -26,6 +27,7 @@
2627
"name": "Mingw64",
2728
"includePath": [
2829
"${workspaceFolder}/src/onsyuri/**",
30+
"${workspaceFolder}/thirdparty/build/arch_mingw64/include/**",
2931
"${msys2sdk}/mingw64/include"
3032
],
3133
"defines": [

.vscode/settings.json

Lines changed: 0 additions & 83 deletions
This file was deleted.

README.md

Lines changed: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Onscripter-Yuri
22

3-
![GitHub release (latest by date)](https://img.shields.io/github/v/release/YuriSizuku/OnscripterYuri?color=green&label=onsyuri&logo=4chan&style=flat-square) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/YuriSizuku/OnscripterYuri/build_web.yml?label=web&style=flat-square) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/YuriSizuku/OnscripterYuri/build_win.yml?label=win(x86|x64)&style=flat-square) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/YuriSizuku/OnscripterYuri/build_linux.yml?label=linux(x86|x64|arm|arm64)&style=flat-square) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/YuriSizuku/OnscripterYuri/build_android.yml?label=android(arm|arm64)&style=flat-square)
3+
![GitHub release](https://img.shields.io/github/v/release/YuriSizuku/OnscripterYuri?color=green&label=onsyuri&logo=4chan&style=flat-square)![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/YuriSizuku/OnscripterYuri/build_web.yml?label=web(wasm)&logo=firefox&style=flat-square)![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/YuriSizuku/OnscripterYuri/build_android.yml?label=android(arm|arm64)&&logo=android&style=flat-square)
4+
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/YuriSizuku/OnscripterYuri/build_win.yml?label=win_mingw(x86|x64)&logo=mingww64&style=flat-square)![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/YuriSizuku/OnscripterYuri/build_win_msvc.yml?label=win_msvc(x86|x64|arm64)&logo=codeblocks&style=flat-square)
5+
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/YuriSizuku/OnscripterYuri/build_linux.yml?label=linux(x86|x64|arm|arm64)&logo=linux&style=flat-square)![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/YuriSizuku/OnscripterYuri/build_darwin.yml?label=mac(x64|arm64)&logo=apple&style=flat-square)
46

57
☘️ An enhancement ONScripter project porting to many platforms, especially **web**
6-
We also support for `windows`, `linux`, `android` and `psv`. This project is base on [ONScripter-Jh](https://github.com/jh10001/ONScripter-Jh) by `SDL2`.
8+
We also support for `windows`, `linux`, `mac`, `android`, `retroarch` and `psv`. This project is base on [ONScripter-Jh](https://github.com/jh10001/ONScripter-Jh) by `SDL2`.
79

810
Online Demo: [lifegame](https://onsgame.netlify.app/lifegame/), [luasnow](https://onsgame.netlify.app/luasnow/), [noesis1 (lazyload)](https://onsgame.netlify.app/noesis1/)
911
PSV: [psv-OnscripterJH](https://github.com/YuriSizuku/psv-OnscripterJH/releases)
@@ -14,49 +16,53 @@ Multi Platform: [github action release](https://github.com/YuriSizuku/Onscripter
1416

1517
New features :
1618

17-
- develop
18-
- [x] clear camke project structure
19-
- [x] well documention for develop and usage
20-
- [x] scripts to compile or cross compile without pain
21-
- [x] vscode and android studio project for multi enviroment
22-
- [x] ci in github action to automaticly build
23-
- [x] use docker to build for all platform
19+
- script
20+
- [x] lua script and animation
21+
- [x] support English half-width text, see [Word wrapping](https://github.com/YuriSizuku/OnscripterYuri/issues/2)
22+
- [x] `nt2`, `nt3` script encryption (Mine exclusive format)
23+
- [x] long click or touch to invoke menu
24+
25+
- render
26+
- [x] fullscreen by `--fullscreen` or `alt+enter`, scretch to fullscreen by `--fullscreen2` or `f10`
27+
- [x] arbitary resolution `--width`, `--height`
28+
- [x] gles2 sharpness rendering by `--sharpness 1.0` parameter, fix bug on windows
29+
2430
- platform
2531
- [x] windows
2632
- [x] x86, x64 (local or cross compile by mingw, static link)
2733
- [x] amd64, arm64 (local msvc, vcpkg, contributed by [ryank231231](https://github.com/YuriSizuku/OnscripterYuri/pull/3))
28-
- [x] lua script and animation
2934
- [x] video by system player
3035
- [x] linux
3136
- [x] x86, x64 (local compile, static or dynamic link)
3237
- [x] arm, aarch64 (cross compile, SDL2 build from raspberrypi, static link)
33-
- [x] lua scirpt and animation
38+
- [x] retroarch (contributed by [iyzsong](https://github.com/iyzsong))
39+
- [x] mac
40+
- [x] x64, arm64 (local compile, contributed by [yujincheng08](https://github.com/yujincheng08))
3441
- [x] web (by emscripten)
3542
- [x] fs to save in indexdb
3643
- [x] lazy load by ~~BrowserFS or worker~~ async fetch to avoid block the audio
37-
- [x] lua script and animation
3844
- [x] mobile web with touch, with webui menu
3945
- [x] android
4046
- [x] SDK level above 21 (android 5.1, Lolipop)
4147
- [x] extern SD card by [SAF](https://github.com/YuriSizuku/android-SafFile), and scoped storage
4248
- [x] non-english charactor in path
43-
- [x] lua script and animation
4449
- [x] video by system player
4550
- [x] psv, see [psv-Onscripter](https://github.com/YuriSizuku/psv-OnscripterJH)
46-
- render
47-
- [x] fullscreen by `--fullscreen` or `alt+enter`, scretch to fullscreen by `--fullscreen2` or `f10`
48-
- [x] arbitary resolution `--width`, `--height`
49-
- [x] gles2 sharpness rendering by `--sharpness 1.0` parameter, fix bug on windows
50-
- other
51-
- [x] support English half-width text, see [Word wrapping](https://github.com/YuriSizuku/OnscripterYuri/issues/2)
52-
- [x] `nt2`, `nt3` script encryption (Mine exclusive format)
53-
- [x] long click or touch to invoke menu
54-
- onsjh bug fix
51+
52+
- bugfix
5553
- [x] fix some bugs in origin version (can not read `00.txt` problem)
5654
- [x] fix lua animation problem
5755
- [x] fix android onresume gles null pointer
5856
- [x] fix android file stat problem (save not found)
5957

58+
- develop
59+
- [x] clear camke project structure
60+
- [x] well documention for develop and usage
61+
- [x] scripts to compile or cross compile without pain
62+
- [x] vscode and android studio project for multi enviroment
63+
- [x] ci in github action to automaticly build
64+
- [x] use docker to build for all platform
65+
6066
## 1. Usage
6167

6268
### (1) general command
@@ -65,7 +71,7 @@ New features :
6571
./onsyuri --help
6672
./onsyuri --root /path/to/game --save-dir /path/to/save --font /path/default.ttf --enc:sjis
6773
./onsyuri --width 1280 --height 720 --sharpness=3.1
68-
./onsyuri --fullscreen2 # fullscreen1 alt+f4, fullscreen2 f11
74+
./onsyuri --fullscreen2 # fullscreen1 alt+f, fullscreen2 f10 (toggle stretch)
6975

7076
Usage: onsyuri [option ...]
7177
-h, --help show this help and exit
@@ -82,8 +88,8 @@ Usage: onsyuri [option ...]
8288
--window start in windowed mode
8389
--width 1280 force window width
8490
--height 720 force window height
85-
--fullscreen start in fullscreen mode (alt+f4 or f11)
86-
--fullscreen2 start in fullscreen mode with stretch (f10)
91+
--fullscreen start in fullscreen mode (alt+f or alt+enter)
92+
--fullscreen2 start in fullscreen mode with stretch (f10 to toggle stretch)
8793
--sharpness 3.1 use gles to make image sharp
8894
--no-video do not decode video
8995
--no-vsync turn off vsync
@@ -113,12 +119,12 @@ You can either download the prebuild static elf from the [release](https://githu
113119
114120
- Arch User Repository
115121
116-
https://aur.archlinux.org/packages/onscripter-yuri
117-
118-
```
119-
# for Arch based distributions, install directly from AUR.
120-
yay -S onscripter-yuri
121-
```
122+
[aur onscripter-yuri](https://aur.archlinux.org/packages/onscripter-yuri)
123+
124+
``` sh
125+
# for Arch based distributions, install directly from AUR.
126+
yay -S onscripter-yuri
127+
```
122128
123129
### (3) web
124130

script/cross_web.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ TARGETS=$@
77

88
# config env
99
source ./_fetch.sh
10-
if [ -z "$EMSDK" ]; then EMSDK=/d/Software/env/sdk/emsdk; fi
10+
if [ -z "$EMSDK" ]; then EMSDK=/d/Software/sdk/emsdk; fi
1111
if [ -n "$(uname -a | grep Msys)" ]; then # fix python problem in windows
1212
if [ -z "$MSYS2SDK" ]; then MSYS2SDK=/d/Software/env/msys2; fi
1313
PATH=$MSYS2SDK/mingw32/bin/:$PATH

src/onsyuri/ONScripter_event.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1140,7 +1140,7 @@ bool ONScripter::keyPressEvent( SDL_KeyboardEvent *event )
11401140
}
11411141

11421142
if ( event_mode & ( WAIT_INPUT_MODE | WAIT_BUTTON_MODE ) ){
1143-
if ( event->keysym.sym == SDLK_f ){
1143+
if ( event->keysym.sym == SDLK_f ){ // alt+f for fullscreen
11441144
if ( fullscreen_mode ) menu_windowCommand();
11451145
else menu_fullCommand();
11461146
}

src/onsyuri/onscripter_main.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ void optionHelp()
6969
printf( " --window\t\tstart in windowed mode\n");
7070
printf( " --width 1280\tforce window width\n");
7171
printf( " --height 720\tforce window height\n");
72-
printf( " --fullscreen\tstart in fullscreen mode (alt+f4 or f11)\n");
73-
printf( " --fullscreen2\tstart in fullscreen mode with stretch (f10)\n");
72+
printf( " --fullscreen\tstart in fullscreen mode (alt+f or alt+enter)\n");
73+
printf( " --fullscreen2\tstart in fullscreen mode with stretch (f10 toggle stretch)\n");
7474
printf( " --sharpness 3.1 \t use gles to make image sharp\n");
7575
printf( " --no-video\tdo not decode video\n");
7676
printf( " --no-vsync\tturn off vsync\n\n");

0 commit comments

Comments
 (0)