Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Linux Support #21

Merged
merged 3 commits into from
Jun 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This extension allows you to edit scripts directly in Visual Studio Code without

- **Automatic Saving and Compilation**: Pressing `CTRL + S` saves your files and compiles your code automatically, so you don't have to worry about losing your progress.

- **Test Play (Windows Only)**: Pressing `F5` allows you to quickly test your code on Windows without having to run any additional commands.
- **Test Play**: Pressing `F5` allows you to quickly test your code without having to run any additional commands.

## Screenshots

Expand All @@ -23,8 +23,13 @@ This extension is a beta version that has not been tested elaborately. We have s

# System Requirements

## Windows
- Ruby version 2.6.8 or higher must be installed on your system.

## Linux
- Ruby version 2.6.8 or higher must be installed on your system.
- Wine (preferably the latest version)

# Change Log

## 0.1.0
Expand All @@ -33,6 +38,7 @@ This extension is a beta version that has not been tested elaborately. We have s

- Added a Script Explorer that allows users to add, remove, and refresh script files.
- Added a feature to hide the status bar.
- Added Linux support.

# Marketplace Link

Expand All @@ -53,18 +59,25 @@ This extension is a beta version that has not been tested elaborately. We have s

# Usage

This extension is designed for use on macOS and Windows 11. Before using this extension, you must first install `ruby 2.6.8` or higher on your local machine. Here's how to check if Ruby is already installed:

To use this extension, you must have Ruby installed on your computer (Ruby comes pre-installed on Mac, so you can ignore this step if you're on a Mac). I tried using a Node module like `Marshal` or a WASM-based Ruby because I didn't want to require a Ruby installation, but they were not stable.
This extension is designed for use on macOS, Windows 11 and Linux. Before using this extension, you must first install `ruby 2.6.8` or higher on your local machine.

To check if Ruby is installed on your computer, run this command in your terminal or command prompt:

```bash
ruby -v
```

Ruby comes pre-installed on Mac, so you can ignore this step if you're on a Mac. I tried using a Node module like `Marshal` or a WASM-based Ruby because I didn't want to require a Ruby installation, but they were not stable.

If Ruby is installed properly, you should see the version number displayed (e.g., `ruby 3.2.1`).

If running this extension on Linux you will also need to install `Wine` on your system to support testing the game.

To check if Wine is installed in your system you can run this command:
```bash
wine --version
```

# Maintainer and Contributors

- Extension Maintainer
Expand Down
Loading