acelib's Introduction

Ace Library

A library module for using the Ace editor in Foundry VTT.

This library is currently being used by

Let me know and I will add your module to the list.

Installation

In the setup screen, use the URL https://github.com/arcanistzed/acelib/releases/latest/download/module.json to install the module.

Usage

To easily add an Ace editor, you can create a <div> and use ace.edit to initialize. You can create multiple editors at once with this method.

let editor = ace.edit("the-id-of-the-div");

This will set the Ace options to the ones that the user has configured in module settings.

editor.setOptions(ace.userSettings);

Set the editor's contents

editor.setValue("initial value");

Get the editor's contents

editor.getValue();

Instructions for customizing each editor individually are available on the official guide which has examples of how to set various options. This is useful when you need an editor to work a certain way (e.g. force the use of JSON), but should be used sparingly since it robs the user of their choice. These will override the user's choices. Different editors can use different options even if they are open simultaneously.

Using Ace

Press Ctrl+Alt+h or Cmd+Alt+h to view a list of all the keyboard shortcuts available. You can access the command palette by pressing F1 while focusing on the editor.

Support

Please consider supporting me on my Patreon if you like my work. You can see a list of all my projects on my website.

Bugs

You can submit bugs via Github Issues or on my Discord server.

Contact me

Come hang out on my my Discord server or click here to send me an email.

License

This package is under an MIT license and the Foundry Virtual Tabletop Limited License Agreement for module development while Ace Editor is under a BSD license.

acelib's People

Contributors

Stargazers

Watchers

acelib's Issues

[Bug]: Javascript mode doesn't work

Expected Behavior

Javascript code should be properly highlighted

Current Behavior

Behaves as plaintext

Steps to Reproduce

Open Settings
Navigate to mode
Set it to javascript
Save settings
Open any editor
Observe effects

Context

Version

1.8.3

Foundry VTT Version

11.315

Operating System

Windows 11

Browser / App

Native Electron App

Game System

wfrp4e (dev branch effect-refactor)

Modules Disabled

I can confirm that disabling all of my other modules doesn't fix this issue.

Feature Request: Settings option for using Tab character instead of spaces

I won't get into the age old debate on if tabs or spaces are better, but I personally prefer tabs and am constantly annoyed that the web dev world seems to have baked in "spaces" as being expected, while the rest of the programming world accepts either or. The Ace Editor appears to be no different and sets the default to spaces and I don't see a setting in the acelib module to change that yet. Could you add a way to toggle the use of the Tab character instead of spaces in the Ace Lib configuration?

Recommend Projects

arcanistzed / acelib Goto Github PK