diff --git a/readme.md b/readme.md index 3356582..f7687c9 100644 --- a/readme.md +++ b/readme.md @@ -1,175 +1,84 @@ ## Cesium -Cesium is the first *shell* for the TI-84 Plus CE / TI-83 Premium CE calculators, and includes many useful features. +Cesium is a shell for the TI-84 Plus CE / TI-83 Premium CE calculators. -### Installing +![screenshot programs](https://usercontent.irccloud-cdn.com/file/6oQrOSVE/screenshot_2.png) +![screenshot apps](https://usercontent.irccloud-cdn.com/file/LY64w3ju/screenshot_1.png) -In order to transfer Cesium to your calculator, you must have a linking program, such as TI-Connect CE: https://education.ti.com/ticonnectce. Once installed: +Cesium is installed by running the `CESIUM` program. +This creates an application that can accessed via the `apps` button. +The application cannot be transferred to other calculators, however the installer can be used instead. -1. Plug-in your calculator and Launch TI-Connect CE -2. Send `cesium.8xp` (or `cesium_french.8xp` if needed) -3. Drag'n'drop them onto the calculator that should be in the devices list in TI-Connect CE -4. Press the Send button in the window that pops up. +A video showing off various features is available [here](https://youtu.be/hZDzV1CDN3k). -Congratulations, Cesium is now on your calculator! +### Navigation -### Running -For the first run, execute Cesium as you would any other assembly program by pressing 2nd + 0 and choosing the `Asm(` token. -Then press prgm and choose `CESIUM`. The homescreen should look like this: +Cesium supports alpha search for programs. +Use any key with the green text above it to immediately switch to the programs starting with the corresponding letter. - Asm(prgmCESIUM +| Combination | Action | +|-----------------|--------------------------| +| `2nd` / `enter` | Run, select | +| `alpha` | Modify variable settings | +| `zoom` | Edit BASIC program | +| `y=` | Create new BASIC program | +| `graph` | Rename program / appvar | +| `mode` | Enter settings menu | +| `arrow keys` | Move places | +| `green letters` | Alpha search for program | -*If you have OS 5.3 or above, you can just do:* +### Shortcuts - prgmCESIUM +Shortcuts are available from outside of the Cesium application. -Press enter to execute. +| Combination | Action | +|----------------|--------------------------------------------------------| +| `on` + `prgm` | Launch Cesium Application | +| `on` + `stat` | Power down with password on wake (No Default Password) | +| `on` + `graph` | Open label jumper in TI-Basic Editor | +| `on` + `8` | Backup RAM from TI-OS | +| `on` + `5` | Remove latest RAM backup | +| `on` + `2` | Restore RAM from latest backup | -**NOTE:** The `Cesium` application is accessible with the apps button; *not* with the prgm button. +The power-on password is set via the settings menu by pressing the `sto->` button. +RAM backup is performed by copying RAM contents to flash memory, so if you are concerned about flash wear, please moderate usage. -Once installed, the application cannot be transferred to other calculators. If you wish to transfer Cesium to other calculators after installation, you must transfer the installer itself to other calculators. +### Uninstalling -### Controls -Cesium provides a way to quickly jump to different programs in the program browser. Simply press one of the keys with a green letter above it, and it will take you to the first program with that starts with that letter. +To uninstall Cesium in the event a new version is warranted, press `2nd` + `+` + `2` + `1` and delete the Cesium application and appvar. +You can also delete the Cesium application from within Cesium. -| Combination | Action | -|-----------------|--------------------------------------------| -| 2nd / enter | Run, select | -| alpha | Edit program options | -| zoom | Edit BASIC program | -| y= | Create new BASIC program | -| graph | Rename program / appvar | -| mode | Enter settings menu | -| up / down | Move places | -| green letters | Alpha search for program | +### Building -### Shortcuts -Shortcuts are available from the TI-OS system anywhere. Simply hold the on key and press the corresponding button to trigger the action. -Available actions: - -| Combination | Action | -|-------------|-----------------------------------------------------------------------------| -| on + prgm | Launch Cesium Application | -| on + stat | Power down with password on wake (No Default Password) | -| on + graph | Open label jumper in TI-Basic Editor | - -The label jumper is a handy feature for those editing Basic or ICE programs, and allows quick navigation to any label listed in the program. - -You can change the password from the settings menu (Accessed using mode), and pressing the sto→ button. This will prompt for a new password which will be automatically saved. -*Note: There is no default password as before.* - -### External Backup -Cesium also offers the ability to externally back up the RAM from within the OS. These are also tied to the shortcuts: - -**THE FLASH CHIP IS ONLY DESIGNED TO SUPPORT 100,000+ ERASE CYCLES. PLEASE BE SURE TO MODERATE USEAGE.** - -| Combination | Action | -|-------------|------------------------------------------------------------| -| on + 8 | Backup RAM from TI-OS | -| on + 5 | Remove latest RAM backup | -| on + 2 | Restore RAM from latest backup | - -### Running Programs -Cesium can run programs written in ASM, C, ICE, or BASIC, either from the archive or not. It is prefered that you place programs in the archive, as it will protect them against RAM clears. -To run a program, simply press 2nd or Enter. After a program is finished running, it will return to Cesium. -Note: pressing 2nd to back up RAM before running will only work if the "Backup RAM" option is enabled in the Cesium settings. Otherwise, the program will be run without backing up the RAM. - -### Features -*HUD:* -* Displays battery level. -* Program count. (toggle in settings) -* Current time. (toggle in settings, the clock MUST be set from TI-OS for the time to be 'correct') -* Custom color scheme. (changeable in settings) - -*Backup features:* -* Backup RAM before executing programs (with [2nd] button). If a program crashes, nothing will be deleted or lost! (toggle in settings) -* Quick launch button (the [enter] button) that skips backup process. -* External backup, if your calculator crashes outside of Cesium, everything is still protected! (done from homescreen) -* Restore External backup feature so you can revert your calculator back to its backed-up state whenever you want. (also done from homescreen) -* Video of every backup feature and how to use them: https://youtu.be/hZDzV1CDN3k - -*Basic Features:* -* Quick launch with on + prgm (toggle in settings) -* Quick (adjustable) password lock with on + stat (toggle in settings) - -* Run ASM , C, and ICE programs directly. -* Run Archived programs with any OS. -* Edit Archived BASIC programs and an instant goto for errors. (Won't edit locked programs) -* While editing program, you have access to the entire screen (the "PROGRAM:NAME" line isn't there for more space) -* Turn off run/busy indicator when running BASIC programs. (toggle in settings) - -*Program Features:* -* Search for programs for a quick lookup. (press the letter with the green letter above it corresponding to the first letter of the program you're searching for) -* Archive programs. -* Lock programs from editing. -* Hide programs from normal prgm button (the TI-OS program menu). -* Rename a program / appvar. -* Create a program. -* Delete a program. -* Edit a program directly. - -* Folder dedicated to FLASH applications. -* Folder dedicated to AppVar management. -* Automatically quits after about 20 to 25 seconds of inactivity so it won't drain your battery. - -* Displays program details such as: - * Displays an icon next to the programs name and above extra information. - * Language the program was written in. - * How large a program is. - * Extra information about a program at the bottom of the HUD. - -*Settings* -* Color selection (toggle with mode): - * Theme color (primary color). - * Main text color (secondary color). - * Highlight color. - * Inversion color. - * Hidden programs color. - * Background color. -* Disabling busy run indicator in Basic programs. -* Toggle show program/directory item count. -* Toggle display clock. -* Toggle running with RAM backup. -* Toggle showing special directories (Applications and AppVars). -* Enable/disable keyboard short cuts (Open Cesium hook, turn off with password hook, and external backup hooks). -* Toggle show item deletion confirmation to prevent accidentally deleting something you don't want to. -* Change LCD brightness - -*Language support:* -* English -* French (Credits to Adriweb for translation!) +Clone with the following: -### Uninstalling -First off, why would you ever want to delete such an awesome shell? + git clone --recurse-submodules https://github.com/mateoconlechuga/cesium.git -To uninstall Cesium, press 2nd + + + 2 + 1 and delete the Cesium Application and appvar. Or you can delete anything Cesium from TI-Connect CE. +Download fasmg, available near the bottom of [this page](https://flatassembler.net/download.php). +Place fasmg in the project root or add it to the global path. -You can also delete the Cesium AppVar from Cesium, then delete the App itself. Exit Cesium to finish. -NOTE: The "show special directories" box MUST be selected in order to see the AppVars/ Apps folder!! +Build with the command: -### Building + make -j -Cesium uses submodules to build, so be sure to clone the project like so: -Go to a new folder, then run the following command(s): +### Bug Reports and Feature Requests - git clone --recursive https://github.com/mateoconlechuga/cesium.git +Make a bug report [here](https://github.com/mateoconlechuga/cesium/issues). -Download `fasmg` and place it in the root directory of the repository (Available for your OS near the bottom of [this page](https://flatassembler.net/download.php)), or add it to your global PATH variable. +Source code is available [here](https://github.com/mateoconlechuga/cesium). -Build Cesium using the following `make` commands, depending on what language you want: +If you encounter a bug, no matter how small, please report it. - make - make english - make french +#### Language Translations + +If you would like to add support for another language, feel free to make a PR. + +**French**: Created by Adrien "Adriweb" Bertrand ### Credits -(C) 2015 - 2020 Matt "MateoConLechuga" Waltz -Licensed under BSD 3 Clause. -### Source -Source is available here: https://github.com/mateoconlechuga/cesium +© 2015 - 2020 Matt "MateoConLechuga" Waltz + +Licensed under BSD 3 Clause. -### Bug Reports and Feature Requests -Make a GitHub issue here: https://github.com/mateoconlechuga/cesium/issues -If you encounter an unexpected behavior, please make an [issue on GitHub](https://github.com/mateoconlechuga/cesium/issues/) and/or post a topic on TI community websites detailing exactly went wrong and when. (If there isn't a GitHub issue for a bug, it will likely be ignored) Thanks!