https://github.com/tools4ever-nim/nim-script
NIM Script Template
https://github.com/tools4ever-nim/nim-script
nim template
Last synced: 12 months ago
JSON representation
NIM Script Template
- Host: GitHub
- URL: https://github.com/tools4ever-nim/nim-script
- Owner: Tools4ever-NIM
- Created: 2023-12-19T09:22:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-28T17:00:26.000Z (12 months ago)
- Last Synced: 2025-07-30T13:54:34.011Z (12 months ago)
- Topics: nim, template
- Language: TypeScript
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NIM-Script
NIM-Script is a very basic [node](https://nodejs.org/) project to develop, test and debug your [NIM](https://docs.nimsuite.com) script functions right within Microsoft Visual Code
You can find detailed documentation in the [Wiki](https://github.com/Tools4ever-NIM/NIM-Script/wiki) a short summary is found below.
## Installation
First install [Visual Code](https://code.visualstudio.com/download)
Next install the latest 18.x release of [node](https://nodejs.org/en/about/previous-releases#looking-for-latest-release-of-a-version-branch)
Open the project folder in Visual Code and run `npm i`` in a terminal window
```bash
npm i
```
## Usage
Start NIM and download the nim references file, place this nim.ts file in the src directory.
Create a config.json (according to the options in the config.sample.json file)
In the script.ts you can write your own script functions, some examples are provided.
Use the build task to build the output files to be able to debug your code.
Place calls to your script functions inside main.ts
Now run the project to execute the function in main.ts which in turn will execute your script functions.