more docs + build

Author: MrPicklePinosaur

CONTRIBUTING.md

@@ -0,0 +1,6 @@
+
+<!--pex philosophy: _"everything is a cart"_-->
+
+WIP
+
+

Cargo.toml

@@ -33,7 +33,7 @@ nix = { version = "0.29", features = ["fs", "process", "signal"] }
 winapi = { version = "0.3", features = ["namedpipeapi", "handleapi", "winbase"] }
 
 [[bin]]
-name = "pexos"
+name = "picolauncher"
 path = "src/main.rs"
 
 [[bin]]

README.md

@@ -35,15 +35,27 @@ PICO-8 powered games launcher for the [PeX Console](https://pex-labs.com/)
 
 ## Getting started
 
-### Requirements
+**PicoLauncher** requires an installed version of PICO-8 (if you don't have it, you can buy it [here](https://www.lexaloffle.com/pico-8.php?#getpico8)). You can either use a pre-compiled version from the latest [release]() or build this project from source.
 
-**PicoLauncher** requires an installed version of PICO-8 (if you don't have it, you can buy it [here](https://www.lexaloffle.com/pico-8.php?#getpico8)).
+### Pre-compiled
 
-You can either build this project from source or use a pre-compiled version for your platform.
+Download the pre-compiled release for your platform and unzip it. You will then find executables for all supported platforms. The `drive/` directory will be where the PICO-8 data files will be stored. For now, you can only run **PicoLauncher** from the same directory as the executables.
 
+On windows, if your PICO-8 binary doesn't reside at the default location of `C:\\Program Files (x86)\\PICO-8\\pico8.exe`, you need to set the environment variable `PICO8_BINARY` before launching.
+```sh
+set PICO8_BINARY=<path to pico8>
+./picolauncher.exe
+```
 
+On linux, if PICO-8 is not in your PATH, you need to set the environment variable as well.
+```sh
+PICO8_BINARY=<path to pico8>
+./picolauncher
+```
 
-<!--pex philosophy: _"everything is a cart"_-->
+### Build from source
+
+To build from source, you need to have a [rust toolchain](https://www.rust-lang.org/tools/install) installed. To build **PicoLauncher** for all platforms, there is a provided build script at `dev/scripts/build_linux.sh` and `dev/scripts/build_windows.sh`. The built files are present in the `build_<platform>/` directory, as well as zipped up in `build_<platform>.zip`. This is the same build that is distributed in the pre-compiled release.
 
 ## Contributing
 
@@ -52,13 +64,13 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details! Don't hesitate t
 ## Credits
 
 Pre-bundled games
-- [birds with guns]()
-- [bun bun samurai]()
-- [celeste]()
-- [cherrybomb]()
-- [mot's grand prix]()
-- [oblivion eve]()
-- [pico night punkin']()
-- [poom]()
-- [swordfish]()
+- [birds with guns](https://www.lexaloffle.com/bbs/?tid=45334)
+- [bun bun samurai](https://www.lexaloffle.com/bbs/?tid=54707)
+- [celeste](https://www.lexaloffle.com/bbs/?tid=2145)
+- [cherrybomb](https://www.lexaloffle.com/bbs/?tid=48986)
+- [mot's grand prix](https://www.lexaloffle.com/bbs/?pid=97606)
+- [oblivion eve](https://www.lexaloffle.com/bbs/?pid=142641)
+- [pico night punkin'](https://www.lexaloffle.com/bbs/?tid=42715)
+- [poom](https://www.lexaloffle.com/bbs/?pid=101541)
+- [swordfish](https://www.lexaloffle.com/bbs/?tid=31141)
 

dev/scripts/build.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+set -e
+
+# create file structure
+rm -rf build_linux
+mkdir -p build_linux/
+mkdir -p build_linux/drive/
+mkdir -p build_linux/drive/screenshots/
+mkdir -p build_linux/drive/carts/
+mkdir -p build_linux/drive/carts/screenshots/
+
+# build executables
+cargo build --release --target x86_64-unknown-linux-gnu
+
+# install files
+cp -r drive/carts/{games,labels,metadata,music} build_linux/drive/carts
+cp -r drive/carts/{*.p8,*.lua} build_linux/drive/carts/
+cp drive/config_template.txt build_linux/drive/config.txt
+
+cp target/x86_64-unknown-linux-gnu/release/picolauncher build_linux/picolauncher
+cp target/x86_64-unknown-linux-gnu/release/p8util build_linux/p8util
+
+zip -r build_linux.zip build_linux/

dev/scripts/build_linux.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+set -e
+
+# create file structure
+rm -rf build_windows
+mkdir -p build_windows/
+mkdir -p build_windows/drive/
+mkdir -p build_windows/drive/screenshots/
+mkdir -p build_windows/drive/carts/
+mkdir -p build_windows/drive/carts/screenshots/
+
+# build executables
+cargo build --release --target x86_64-pc-windows-gnu
+
+# install files
+cp -r drive/carts/{games,labels,metadata,music} build_windows/drive/carts
+cp -r drive/carts/{*.p8,*.lua} build_windows/drive/carts/
+cp drive/config_template.txt build_windows/drive/config.txt
+
+cp target/x86_64-pc-windows-gnu/release/picolauncher.exe build_windows/picolauncher.exe
+cp target/x86_64-pc-windows-gnu/release/p8util.exe build_windows/p8util.exe
+
+zip -r build_windows.zip build_windows/

dev/scripts/build_windows.sh

@@ -30,7 +30,7 @@ foreground_sleep_ms 2 // number of milliseconds to sleep each frame. Try 10 to c
 
 background_sleep_ms 10 // number of milliseconds to sleep each frame when running in the background
 
-sessions 3 // number of times program has been run
+sessions 4 // number of times program has been run
 
 // (scancode) hold this key down and left-click to simulate right-click
 rmb_key 0 // 0 for none  226 for LALT

drive/config.txt

@@ -1,4 +1,7 @@
-use std::{fs::{File, OpenOptions}, path::{Path, PathBuf}};
+use std::{
+    fs::{File, OpenOptions},
+    path::{Path, PathBuf},
+};
 
 pub const IN_PIPE: &'static str = "in_pipe";
 pub const OUT_PIPE: &'static str = "out_pipe";
@@ -33,4 +36,3 @@ pub fn open_out_pipe() -> anyhow::Result<File> {
 
     Ok(out_pipe)
 }
-

src/hal/linux.rs

@@ -1,10 +1,11 @@
+use std::{
+    fs::{File, OpenOptions},
+    os::windows::{io::RawHandle, prelude::*},
+    path::{Path, PathBuf},
+    ptr,
+};
 
-use std::os::windows::{io::RawHandle, prelude::*};
-use std::ptr;
-use std::fs::{File};
-use std::path::{PathBuf, Path};
 use anyhow::anyhow;
-
 use winapi::um::{
     fileapi::{CreateFileW, OPEN_EXISTING},
     handleapi::INVALID_HANDLE_VALUE,
@@ -102,3 +103,22 @@ pub fn open_in_pipe() -> anyhow::Result<File> {
     }
 }
 
+/*
+pub fn open_out_pipe() -> anyhow::Result<File> {
+    let mut file = OpenOptions::new()
+        .write(true)
+        .truncate(true)
+        .open("out_pipe")?;
+
+    Ok(file)
+}
+
+pub fn open_in_pipe() -> anyhow::Result<File> {
+    let mut file = OpenOptions::new()
+        .read(true)
+        .truncate(true)
+        .open("in_pipe")?;
+
+    Ok(file)
+}
+*/

src/hal/windows.rs

@@ -1,6 +1,6 @@
 mod consts;
-mod p8util;
 mod hal;
+mod p8util;
 
 use std::thread; // TODO maybe switch to async
 use std::{
@@ -15,11 +15,11 @@ use std::{
 
 use anyhow::anyhow;
 use consts::*;
+use hal::*;
 use notify::event::CreateKind;
 use notify_debouncer_full::{new_debouncer, notify::*, DebounceEventResult};
 use p8util::*;
 use serde_json::Map;
-use hal::*;
 
 fn parse_metadata(path: &Path) -> anyhow::Result<String> {
     let content = read_to_string(path)?;