ARISGames / aris-android-client

MIT License
3 stars 5 forks source link

Build instructions #1

Open mrdavidgagnon opened 8 years ago

mrdavidgagnon commented 8 years ago

I'd love to checkout current progress but am an android n00b. I have Android Studio running but don't know how to open/import the project and get it to build. Might you write a few steps to get me going?

flanneltuba commented 8 years ago

Hi David -

It should be fairly simple: • go to the main GitHub page for the ARIS Android repo at: https://github.com/ARISGames/aris-android-client https://github.com/ARISGames/aris-android-client • locate and copy the Clone URL in the field labeled “HTTPS”. it should be: https://github.com/ARISGames/aris-android-client.git • open Android Studio (get the latest version, 2.1) in Android Studio click on the VCS menu, select Checkout from Version Control->GitHub • paste in the GitHub Clone URL from step #2 • fill in/edit/verify as needed, the Parent Directory and Name fields • click “Clone” button

Once the repo has loaded, and settled (all the little progress wheels on the bottom of the project page have completed), you should be able to select Run ‘app’ from the Run menu. You might be offered a simulator to run on, though they are very flakey and might not run at all with a location dependent mobile app such as is ARIS; I recommend, and perhaps would go so far as to say, recommend exclusively, that you get ahold of an actual Android device, one with GPS and at least wifi network connectivity. I suspect you won’t get past the login screen on a simulator, since I haven’t bulletproofed the code against non-location capable devices; the last time I tried, it died upon login. Important: To be able to load an app from Android Studio to a physical Android device, you will need to enable its Developer mode and USB Debugging. The secret little trick to doing this is described here: http://www.androidcentral.com/how-enable-developer-settings-android-42 http://www.androidcentral.com/how-enable-developer-settings-android-42 You will also need to pysically connect the device to your computer via a USB cable for the app (known as the APK) to load. There are alternate ways to load apps onto non-developer-moded devices, (e.g. you can email the APK file from your computer to a device’s email client) but the above method should be the most straightforward.

At present, the Android client can play basic, non-javascript encoded, dialog-based games with plaques, items, and should work with maps, but they were untested as of my last code commits. There will be bugs. Don’t be surprised if you encounter outright crashes under some circumstances, especially with games of any above-basic functions. There are some notable delays especially when loading games that are not currently accompanied by a progress dialog (there are numerous such unfinished “ToDos” in the code.)

Let me know if you have trouble getting it running, or if you have any other question, comments, feedback (positive only ;) or concerns.

On May 10, 2016, at 1:39 PM, David J Gagnon notifications@github.com wrote:

I'd love to checkout current progress but am a android n00b. I have Android Studio running but don't know how to open/import the project and get it to build. Might you write a few steps to get me going?

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/ARISGames/aris-android-client/issues/1

mrdavidgagnon commented 8 years ago

Thanks for the email. The glitch I’m seeing is that when I close the repo and open ti nothing is in the project!

On May 11, 2016, at 12:41 PM, Scott notifications@github.com wrote:

Hi David -

It should be fairly simple: go to the main GitHub page for the ARIS Android repo at: https://github.com/ARISGames/aris-android-client https://github.com/ARISGames/aris-android-client locate and copy the Clone URL in the field labeled “HTTPS”. it should be: https://github.com/ARISGames/aris-android-client.git open Android Studio (get the latest version, 2.1) in Android Studio click on the VCS menu, select Checkout from Version Control->GitHub paste in the GitHub Clone URL from step #2 fill in/edit/verify as needed, the Parent Directory and Name fields click “Clone” button

Once the repo has loaded, and settled (all the little progress wheels on the bottom of the project page have completed), you should be able to select Run ‘app’ from the Run menu. You might be offered a simulator to run on, though they are very flakey and might not run at all with a location dependent mobile app such as is ARIS; I recommend, and perhaps would go so far as to say, recommend exclusively, that you get ahold of an actual Android device, one with GPS and at least wifi network connectivity. I suspect you won’t get past the login screen on a simulator, since I haven’t bulletproofed the code against non-location capable devices; the last time I tried, it died upon login. Important: To be able to load an app from Android Studio to a physical Android device, you will need to enable its Developer mode and USB Debugging. The secret little trick to doing this is described here: http://www.androidcentral.com/how-enable-developer-settings-android-42 http://www.androidcentral.com/how-enable-developer-settings-android-42 You will also need to pysically connect the device to your computer via a USB cable for the app (known as the APK) to load. There are alternate ways to load apps onto non-developer-moded devices, (e.g. you can email the APK file from your computer to a device’s email client) but the above method should be the most straightforward.

At present, the Android client can play basic, non-javascript encoded, dialog-based games with plaques, items, and should work with maps, but they were untested as of my last code commits. There will be bugs. Don’t be surprised if you encounter outright crashes under some circumstances, especially with games of any above-basic functions. There are some notable delays especially when loading games that are not currently accompanied by a progress dialog (there are numerous such unfinished “ToDos” in the code.)

Let me know if you have trouble getting it running, or if you have any other question, comments, feedback (positive only ;) or concerns.

  • Scott Morison Center for Applied Second Language Studies University of Oregon

On May 10, 2016, at 1:39 PM, David J Gagnon notifications@github.com wrote:

I'd love to checkout current progress but am a android n00b. I have Android Studio running but don't know how to open/import the project and get it to build. Might you write a few steps to get me going?

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/ARISGames/aris-android-client/issues/1

— You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub https://github.com/ARISGames/aris-android-client/issues/1#issuecomment-218534172

flanneltuba commented 8 years ago

Hmm. Can’t say why that would happen.

Another way would be to download the zip file from the repo, unzip it and import it (File->Import) into A.S. You won’t be able to push changes to the code base, but at least you can get it running.

I can send you an actual APK file, if you receive it (the email its attached to) on an Android device, it will ask you if you want to install it. That will work too, but of course, you’re frozen at that app version. If you just want to demo it, that would work well enough though. Let me know if you want to do it that way.

On May 11, 2016, at 3:35 PM, David J Gagnon notifications@github.com wrote:

Thanks for the email. The glitch I’m seeing is that when I close the repo and open ti nothing is in the project!

On May 11, 2016, at 12:41 PM, Scott notifications@github.com wrote:

Hi David -

It should be fairly simple: go to the main GitHub page for the ARIS Android repo at: https://github.com/ARISGames/aris-android-client https://github.com/ARISGames/aris-android-client locate and copy the Clone URL in the field labeled “HTTPS”. it should be: https://github.com/ARISGames/aris-android-client.git open Android Studio (get the latest version, 2.1) in Android Studio click on the VCS menu, select Checkout from Version Control->GitHub paste in the GitHub Clone URL from step #2 fill in/edit/verify as needed, the Parent Directory and Name fields click “Clone” button

Once the repo has loaded, and settled (all the little progress wheels on the bottom of the project page have completed), you should be able to select Run ‘app’ from the Run menu. You might be offered a simulator to run on, though they are very flakey and might not run at all with a location dependent mobile app such as is ARIS; I recommend, and perhaps would go so far as to say, recommend exclusively, that you get ahold of an actual Android device, one with GPS and at least wifi network connectivity. I suspect you won’t get past the login screen on a simulator, since I haven’t bulletproofed the code against non-location capable devices; the last time I tried, it died upon login. Important: To be able to load an app from Android Studio to a physical Android device, you will need to enable its Developer mode and USB Debugging. The secret little trick to doing this is described here: http://www.androidcentral.com/how-enable-developer-settings-android-42 http://www.androidcentral.com/how-enable-developer-settings-android-42 You will also need to pysically connect the device to your computer via a USB cable for the app (known as the APK) to load. There are alternate ways to load apps onto non-developer-moded devices, (e.g. you can email the APK file from your computer to a device’s email client) but the above method should be the most straightforward.

At present, the Android client can play basic, non-javascript encoded, dialog-based games with plaques, items, and should work with maps, but they were untested as of my last code commits. There will be bugs. Don’t be surprised if you encounter outright crashes under some circumstances, especially with games of any above-basic functions. There are some notable delays especially when loading games that are not currently accompanied by a progress dialog (there are numerous such unfinished “ToDos” in the code.)

Let me know if you have trouble getting it running, or if you have any other question, comments, feedback (positive only ;) or concerns.

  • Scott Morison Center for Applied Second Language Studies University of Oregon

On May 10, 2016, at 1:39 PM, David J Gagnon notifications@github.com wrote:

I'd love to checkout current progress but am a android n00b. I have Android Studio running but don't know how to open/import the project and get it to build. Might you write a few steps to get me going?

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/ARISGames/aris-android-client/issues/1

— You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub https://github.com/ARISGames/aris-android-client/issues/1#issuecomment-218534172

— You are receiving this because you commented. Reply to this email directly or view it on GitHub https://github.com/ARISGames/aris-android-client/issues/1#issuecomment-218610676

carlb0329 commented 8 years ago

Scott and I were just trying to hash this out. I was finally able to do a successful clone of the project via GitHub in AndroidStudio. Delete what ever project you have now, and do a fresh clone. From Android Studio I chose the “Check out project from version control” then the “GitHub” option. Once there I was able to select the GitHub repo "https://github.com/ARISGames/aris-android-client.git”. It was able to Clone and then open the project in AndroidStudio and it actually has the files in it now. I was also able to successfully build the project as well.

Give it another shot and let us know if it works.

mrdavidgagnon commented 8 years ago

Got it! Looks like the project updates made it easy to clone and build. Thank you.

What games are you building against? The login and game pickers look great but dow (our standard testing game) seemed to freak out the parsers and cause a crash.

I cannot tell you how exciting this is. You guys are killing it.

David

On May 12, 2016, at 1:12 PM, Carl Burnstein notifications@github.com wrote:

Scott and I were just trying to hash this out. I was finally able to do a successful clone of the project via GitHub in AndroidStudio. Delete what ever project you have now, and do a fresh clone. From Android Studio I chose the “Check out project from version control” then the “GitHub” option. Once there I was able to select the GitHub repo "https://github.com/ARISGames/aris-android-client.githttps://github.com/ARISGames/aris-android-client.git%E2%80%9D. It was able to Clone and then open the project in AndroidStudio and it actually has the files in it now. I was also able to successfully build the project as well.

Give it another shot and let us know if it works.

— You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub https://github.com/ARISGames/aris-android-client/issues/1#issuecomment-218840132

flanneltuba commented 8 years ago

Hi David -

I’m pleased to hear you were able to get the code loaded. I had neglected to include some ancillary, yet critical Android Studio settings files in the previous code pushes. I pretty much threw in the entire A.S. kitchen sink. Guess that did the trick!

For the most part, I have been testing agains a couple family simple Dialog based games that I have thrown together in the Editor. I'll publish the one I’ve used most often in early testing that should run without inciting an app meltdown. It’s titled, “My Favorite Martian” and is location independent, and based on an arbitrary but momentarily interesting plot. It would be suitable for perfunctory demonstrations, I suppose—even though it might lack luster and action—it still shows that there is such a thing as ARIS for Android, or at least ARIS Jr.

— — — Scott Morison Educational Software Engineer Center for Applied Second Language Studies (CASLS) 5290 University of Oregon, Eugene, OR 97403 541-346-2954 smorison@uoregon.edu mailto:smorison@uoregon.edu

On May 12, 2016, at 8:12 PM, David J Gagnon notifications@github.com wrote:

Got it! Looks like the project updates made it easy to clone and build. Thank you.

What games are you building against? The login and game pickers look great but dow (our standard testing game) seemed to freak out the parsers and cause a crash.

I cannot tell you how exciting this is. You guys are killing it.

David

On May 12, 2016, at 1:12 PM, Carl Burnstein notifications@github.com wrote:

Scott and I were just trying to hash this out. I was finally able to do a successful clone of the project via GitHub in AndroidStudio. Delete what ever project you have now, and do a fresh clone. From Android Studio I chose the “Check out project from version control” then the “GitHub” option. Once there I was able to select the GitHub repo "https://github.com/ARISGames/aris-android-client.githttps://github.com/ARISGames/aris-android-client.git%E2%80%9D. It was able to Clone and then open the project in AndroidStudio and it actually has the files in it now. I was also able to successfully build the project as well.

Give it another shot and let us know if it works.

— You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub https://github.com/ARISGames/aris-android-client/issues/1#issuecomment-218840132

— You are receiving this because you commented. Reply to this email directly or view it on GitHub https://github.com/ARISGames/aris-android-client/issues/1#issuecomment-218942056

WaterGuerrilla commented 7 years ago

Greetings,

I am using ARIS to create and share a game in iOS and we are hoping to make the same game available for Android users. I feel relatively competent with the ARIS editor and have attempted to follow the above steps to playtest an Android version of our game but am running into walls of my ignorance. Can someone help?

Below is what I've done so far, what I've experienced, and what questions I do have:

  1. I followed the instructions posted to Field Day forums on Dec. 16, 2016 (which seem based on the GitHub instructions from Scott Morrison of May 10-12, 2016). I have installed Android Studio. I have downloaded the zipped aris-android-client file (twice, actually). Subsequently I had to download Git.exe and identify the local path to Git.exe so Android Studio would function. When I try to unzip the aris-android-client bundle, I get a failure and am unable to unzip. When I open the zipped folder itself as a project in Android Studio, I get a window with a whole bunch of code beyond my ken. I followed the HTTP clone route instead, had to create a GitHub account, and did something with/from something called Gradle, and the ARIS for Android project took a long time to load but did bring up more tabs in the Android Studio window. I created an Android emulator device. I also plugged in an old Android device. When I select "Run" I do not get an option to tell Android Studio where to Run the ARIS for Android. I get a Run/Debug Configurations dialogue with multitudinous options. Various times clicking Run does not result in anything I am familiar with appearing on screen or on my attached device. I don't know what I am doing. I feel in over my head on this issue. Can anyone help?

  2. Is what I am describing above what I am supposed to be accessing when I follow steps 1, 2, and 3? If yes, then what am I missing to proceed? If no, then what steps can I take to troubleshoot?

  3. Where/when does/can/will this ARIS for Android project connect up with the online ARIS editor where we are making our ARIS games? Are we making separate ARIS games in/through Android Studio or does this allow existing games to be ported into Android devices?

  4. How do I port over an existing ARIS game to be playtested/played on Android devices?

  5. How do I make others able to access ARIS for Android--does the app appear in the Play Store as it does in the App Store? When/how will it be made available for ARIS game users beyond one following a multi-step developer process to access it?

Thank you,

Michael Timm michaelalantimm@yahoo.com