This project is forked from the original author at Studio O.G.A (http://onscripter.osdn.jp/onscripter.html). This fork is suppose to fix many issues and play almost any ONScripter game of any language.
The original project only supported Japanese text however my project supports Japanese, English, Korean, Chinese, and UTF-8 (like Spanish, Russian, French, German etc) which covers the bulk of Europe and other non-Asian countries.
- Fixes a bunch of crashes
- Supports higher quality audio
- Multiple languages which is detected at runtime (Japanese, English, Korean, Chinese, UTF-8)
- Supports loading saves from different folder
- Android logging and ndk error handling
- When loading corrupted save file, it will not crash
- Compatible with ONScripter-EN
- Supports building for newer versions of Android (the original has issues with newer versions of Android)
- Supports using .nsa and .sar resource files in the same directory
- Handles font size differently to allow increasing font size
This is a very simple example of enabling ONScripter in your app with events.
public class GameActivity extends Activity {
private ONScripterView mGame;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
boolean useHQAudio = true;
boolean renderOutline = true;
// Simple Constructor
// Looks for default.ttf inside game folder, if not found it will crash
// mGame = ONScripterView(this, "/sdcard/path/to/game/directory");
// Constructor with Specified Font
// mGame = ONScripterView(this, "/sdcard/path/to/game/directory", "/path/to/font/file");
// Constructor with Specified Font and Choice of Audio
// mGame = ONScripterView(this, "/sdcard/path/to/game/directory", "/path/to/font/file",
// useHQAudio, renderOutline);
// Full Constructor with Specified Save Path
mGame = ONScripterView(this, "/path/to/game/directory", "/path/to/font/file",
"/path/to/save/folder", useHQAudio, renderOutline);
setContentView(mGame);
// [Optional] Receive Events from the game
mGame.setONScripterEventListener(new ONScripterEventListener() {
@Override
public void autoStateChanged(boolean selected) {
// User has turned on auto mode
}
@Override
public void skipStateChanged(boolean selected) {
// User has turned on skip mode
}
@Override
public void onUserMessage(UserMessage messageId) {
if (messageId == ONScripterView.CORRUPT_SAVE_FILE) {
Toast.makeText(this, "Cannot open save file, it is corrupted");
}
}
@Override
public void videoRequested(final String filename, final boolean clickToSkip, final boolean shouldLoop) {
// Request playing this video in an external video player
// If you have your own video player built into your app, you can
// pause this thread and play the video. Unfortunately I was unable
// to get smpeg library to work within this library
try {
String filename = filename.replace('\\', '/');
Uri uri = Uri.parse(filename2);
Intent i = new Intent(Intent.ACTION_VIEW);
i.setDataAndType(uri, "video/*");
startActivityForResult(i, -1);
}
catch(Exception e){
Log.e("ONScripter", "playVideo error: " + e.getClass().getName());
}
}
@Override
public void onNativeError(NativeONSException e, String line, String backtrace) {
Toast.makeText(this, "An error has occured: " + line);
Log.w("ONScripter", backtrace);
}
});
}
@Override
protected void onPause() {
super.onPause();
if (mGame != null) {
mGame.onPause();
}
}
@Override
protected void onResume() {
super.onResume();
if (mGame != null) {
mGame.onPause();
}
}
@Override
protected void onStop() {
super.onStop();
if (mGame != null) {
mGame.onStop();
}
}
@Override
protected void onUserLeaveHint() {
super.onUserLeaveHint();
if (mGame != null) {
mGame.onUserLeaveHint();
}
}
@Override
public void onDestroy() {
if (mGame != null) {
mGame.exitApp();
}
super.onDestroy();
}
}
Most of the features are specified in ONScripterView.java
setONScripterEventListener(ONScripterEventListener listener)
- Specify an event listener to get all the events from the C++ side
sendNativeKeyPress(int keycode)
- Run a key event to SDL
- KeyEvent.KEYCODE_O: toggle text speed
- KeyEvent.KEYCODE_S: toggle skip mode
- KeyEvent.KEYCODE_A: toggle auto mode
- KeyEvent.KEYCODE_BACK: simulate right click
- KeyEvent.KEYCODE_DPAD_LEFT: simulate scrolling up
- KeyEvent.KEYCODE_DPAD_RIGHT: simulate scrolling down
getGameFontSize()
- Returns the pixel size of the font currently in game
getGameWidth()
- Returns the game's width (not the width the view is taking up). For most games it may be 680px
- Use to calculate and resize the game to your activity
getGameHeight()
- Returns the game's height (not the height the view is taking up). For most games it may be 480px
- Use to calculate and resize the game to your activity
setFontScaling(double scaleFactor)
- Input a scaling factor for the text where 1.0 is default
-
Clone the project to the root directory of your project:
https://github.com/matthewn4444/onscripter-engine-android.git
-
Add this project to your Android Studio project either by adding as module or add this in settings.gradle
``include ':onscripter-engine-android'`
Also include as dependency in build.gradle
dependencies { ... compile project(':onscripter-engine-android') ... }
-
If asked for NDK directory, you should specify it
-
Sync and build project
Copyright (C) 2015 Matthew Ng Licensed under the GNU LGPL license
onscripter, bzip, freetype, jpeg, libmad, lua, png, sdl, sdl_image, sdl_mixer, sdl_ttf, and tremor are distributed on theirs own license.
This library was modified by Matthew Ng from the original author Studio O.G.A. (http://onscripter.osdn.jp/onscripter.html)