Skip to content

Commit

Permalink
README intro steps
Browse files Browse the repository at this point in the history
  • Loading branch information
WakeRealityDev committed Aug 27, 2017
1 parent f3e4737 commit d906225
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@ Makefile*
# QtCtreator CMake
CMakeLists.txt.user*


# Compile RemGlk + Interpreter work folders
remglk_desktop_src/
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,33 @@
# Thunderquake_Qt
Thunderquake technology preview & proof-of-concept app, for Qt 5.9.1 to run RemGlk
Thunderquake::Qt technology preview & proof-of-concept app, for Qt 5.9.1 to run RemGlk

This is my first Qt app, but it turned out as a decent enough working example.

# Running on PC desktop

This was tested on Ubuntu 17.04 x86 desktop system with Qt Creator version 4.3.1 and Qt version 5.9.1

To make a desktop app to run Glulxe interpreter stories:

1. check out from github
2. run the bash script desktop_build_RemGlk_and_terp_r0.sh to comple RemGlk + Glulxe
3. Open the Thunderquake_Qt_GitHub.pro file in QT Creator
4. Try to run on your desktop

It should automatically scan your entire hard drive for .gblorb files for Glulx stories. Download some story files before you start the app.

The bash script in #2 is pretty simple, if you are on non-Linux system you can easily run these steps by hand.

# Android instead of PC desktop

It can run on Android - but you have to use another project to compile the RemGlk + Glulxe interpreters.

There is another project called Thunderfall that is for using the Google Android NDK to compile RemGlk + Glulxe and other interpreters:
https://github.com/WakeRealityDev/IFTerpCrossCompileAndroidCMake

The Thunderquake_Qt_GitHub.pro will need to be edited with what path to pull the compiled Glulxe binary exectuable from, etc. Ask for help if you need it. Again, this is a proof-of-concept, usability on Android is pretty poor, especially the scrolling touchscreen support.


# ToDo list based on prior RemGlk experience

The file README_state_of_this_app_code_as_Glk_frontend.txt has extensive comments on what is missing in terms of Glk features.
8 changes: 6 additions & 2 deletions desktop_build_RemGlk_and_terp_r0.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
#!/bin/bash

#
# (c) Copyright 2017 Stephen A. Gutknecht. All rights reserved.
# License granted: Public Domain.
#

# Makefile for RemGlk discussion
# http://www.intfiction.org/forum/viewtopic.php?f=7&t=19868&start=10
Expand All @@ -15,8 +19,8 @@ build_directory_name="remglk_desktop_build"

pwd
# confirm the path is where we expect it to be for relative work
if [ ! -f "Qt_Thunderquake_WR0.pro" ]; then
echo "!!!! ERROR_CODE:A00 expected Qt_Thunderquake_WR0.pro does not exist, aborting"
if [ ! -f "Thunderquake_Qt_GitHub.pro" ]; then
echo "!!!! ERROR_CODE:A00 expected Thunderquake_Qt_GitHub.pro does not exist, aborting"
exit 1
else
echo "!!!! Running from Thunderquake project folder"
Expand Down

0 comments on commit d906225

Please sign in to comment.