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.
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);
// Defined uri either content:// (external devices like sdcard) or file://
Uri uri = Uri.fromFile(new File("/path/to/folder/with/game"));
mGameView = new ONScripterView.Builder(getContext(), uri)
// If you specify a screenshot folder name, relative to the save folder in game,
// full sized screenshots are saved after each save
.setScreenshotPath("")
// Outline of text
.useRenderOutline()
// Plays higher quality audio
.useHQAudio()
// Set a default font path
.setFontPath(defaultFontPath)
.create();
setContentView(mGame);
// [Optional] Receive Events from the game
mGame.setONScripterEventListener(new ONScripterView.ONScripterEventListener() {
@Override
public void autoStateChanged(boolean selected) {
// User has toggled auto mode
}
@Override
public void skipStateChanged(boolean selected) {
// User has toggled skip mode
}
@Override
public void singlePageStateChanged(boolean selected) {
// User has toggled single page mode
}
@Override
public void onUserMessage(UserMessage messageId) {
if (messageId == ONScripterView.CORRUPT_SAVE_FILE) {
Toast.makeText(GameActivity.this, "Cannot open save file, it is corrupted",
Toast.LENGTH_SHORT).show();
}
}
@Override
public void videoRequested(String filename, boolean clickToSkip, 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 filename2 = 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 onReady() {
Log.w("ONScripter", "Game is ready");
// Load save file, save1.dat
// mGame.loadSaveFile(1);
}
@Override
public void onNativeError(NativeONSException e, String line, String backtrace) {
Toast.makeText(GameActivity.this, "An error has occured: " + line, Toast.LENGTH_SHORT).show();
Log.w("ONScripter", backtrace);
}
@Override
public void onUserMessage(ONScripterView.UserMessage messageId) {
if (messageId == ONScripterView.UserMessage.CORRUPT_SAVE_FILE) {
Toast.makeText(ONScripterActivity.this, "Cannot open save file, it is corrupted",
Toast.LENGTH_SHORT).show();
}
}
@Override
public void onGameFinished() {
// Game ended
finish();
}
});
// Center the game in the middle of the screen
FrameLayout.LayoutParams p = (FrameLayout.LayoutParams) mGame.getLayoutParams();
p.gravity = Gravity.CENTER;
mGame.setLayoutParams(p);
// Set black background behind the engine
findViewById(android.R.id.content).setBackgroundColor(Color.BLACK);
}
@Override
protected void onPause() {
super.onPause();
if (mGame != null) {
mGame.onPause();
}
}
@Override
protected void onResume() {
super.onResume();
if (mGame != null) {
mGame.onResume();
}
// Set immersive mode
getWindow().getDecorView().setSystemUiVisibility(
View.SYSTEM_UI_FLAG_LAYOUT_STABLE
| View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
| View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN
| View.SYSTEM_UI_FLAG_HIDE_NAVIGATION
| View.SYSTEM_UI_FLAG_FULLSCREEN
| View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
}
@Override
protected void onStop() {
super.onStop();
if (mGame != null) {
mGame.onStop();
}
}
@Override
public void onDestroy() {
// DO NOT EXIT APP HERE, DO IT BEFORE OR PREVIOUS ACTIVITY WILL FREEZE, will fix one day
super.onDestroy();
}
}Most of the features are specified in ONScripterView.java
setONScripterEventListener(ONScripterEventListener listener)
sendNativeKeyPress(int keycode)
getGameFontSize()
getGameWidth()
getGameHeight()
setFontScaling(double scaleFactor)
loadSaveFile(int no)
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) 2019 Matthew Ng Licensed under the GPL 2.
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)