• Listen to a special audio message from Bill Roper to the Hive Workshop community (Bill is a former Vice President of Blizzard Entertainment, Producer, Designer, Musician, Voice Actor) 🔗Click here to hear his message!
  • Read Evilhog's interview with Gregory Alper, the original composer of the music for WarCraft: Orcs & Humans 🔗Click here to read the full interview.

Warcraft 3 Lua Package Manager (WLPM) 0.7-beta

Author(s)
ScorpioT1000
Tags
Windows, JASS / Scripting
Size
39.16 MB
Rating

(2 ratings)

Downloads
217
Created
Jun 3, 2019
Updated
Jun 6, 2019
Resources
1
State
Awaiting update
This bundle is marked as awaiting update. A staff member has requested changes to it before it can be approved.
View usage Statistics Legacy download
  • Like
Reactions: Bribe and Toadcop
GitHub Source URL

A modern solution for Warcraft 3 map development!

Brings package management and es6-like Lua modules to your map project.

Features

WLPM consists of a Package Manager and a Module Manager with it's own Lua part of code.

We introduce a new way of working with dependencies - WLPM Module Manager

Package Manager Features

- Works with maps in a map-as-directory mode
- Own package config format in JSON
- Install packages with dependencies from Github and Bitbucket
- Install Lua files directly from Github, Bitbucket or custom hosts in config
- File and directory watcher (war3map.lua, sources, config)
- Dependency version resolution

Module Manager Features

- Include custom user directories as advanced sources
- Right dependency order in the target file
- ES6-like imports and exports in the Lua script
- Really fast target builder on-the-go (C# watcher)

Download


WLPM for Windows 10 x64

WLPM for any Windows (legacy)

WLPM for macOS (planned, waiting for Warcraft 3 fixes)

Quick Start


1. Install WLPM
2. Save your map as a directory (Save as... menu item)
3. Open any terminal window (press Win+R and enter "cmd")
4. enter cd <your map directory>
5. then enter wlpm - it shows all applicable commands

To initialize your package enter wlpm update. It will create wlpm-package.json and .wlpm directory with the dependencies. If you use git (mercurial/svn/...) add .wlpm to your ignore file (.gitignore).

To add new dependency enter wlpm install <package> <version>

Example:


Code: 
wlpm install https://github.com/Indaxia/wlpm-wc3-demo-hello-user

We don't recommend to use "any" version in public projects. Some scammers or stolen accs may update the code and make it malicious.

Specific version example (retrieve from git tag):


Code: 
wlpm install https://github.com/Indaxia/wlpm-wc3-demo-hello-user 1.1


Use wlpm watch to let watcher notify PM and MM if something changed and perform download new packages and/or rebuild modules.

To get help about module management refer the MM documents.

Advanced Usage


Including files

You can include files directly (Big Integer in the example):

Code: 
wlpm install https://raw.githubusercontent.com/DeBos99/lua-bigint/master/bigint.lua * file


Disabling Module Manager (MM) script

If you don't want to use MM on the client (Lua) side you can disable it by adding a new option to your wlpm-package.json:

"insertModuleLoader": false

With this option MM just includes code of the dependencies without the MM

Executing a command after building

It's possible execute a terminal command when the building process finishes:

Code: 
"afterBuild": "echo \"hello world\""

It works for root projects only.

Publishing Packages


If you want to publish your package folow these steps:
1. Create a git repository at Github or Bitbucket
2. Create wlpm-package.json in the repository root
3. Add the "dependencies" and "sources" parameters. Refer the full config example below.
4. (optional) add git tag to the repository
5. Now this is a WLPM package!

Full config example (wlpm-package.json)


Code: 
{
    "title": "WLPM - Demo Map Package", // (optional) your package or root project title
    "author": "ScorpioT1000 / [email protected]", // (optional) author information
    "license": "MIT", // (optional) source code license
    "dependencies": { // list of packages and files required by your source code
        // github repository from a master branch
        "https://github.com/123/456": "*",
 
        // github repository from the release tagged as "1.1.1"
        "https://github.com/123/456": "1.1.1",
 
        // bitbucket repository from the release tagged as "1.0.0" in an object format
        "https://bitbucket.org/123/789": { "type": "package", "version": "1.0.0" },
 
        // inserts a file directly from the repository
        "https://github.com/123/456/blob/master/somefile.lua": {
            "type": "file",
            "topOrder": true  // omit this option or set to false to insert the file after repositories' sources
        }
    },
    // (optional for root project) where your sources are stored. It's important for the package, but can be omitted for root project (it watches "target")
    "sources": [
        "src"
    ],
    // (optional) where to store compiled lua build. It works for root project only.
    "target": "war3map.lua",
    // (optional) execute this command after build, e.g. "echo \"Hello!\""
    "afterBuild": "",
    // (optional) set this to false if you want to replace built-in module manager by your own
    "insertModuleLoader": true,
    // (optional) allow more hosts for direct file dependency (allows github.com and bitbucket.org by default). It works for root project only.
    "allowHosts": []
    // (optional) set custom file extensions when building "sources"
    "sourceExtensions": "*.lua"
}


Restrictions


1. It doesn't support partial version placeholders like 1.* because it doesn't use package registry
2. It performs full re-download on any config requirement change (planned to fix in the future)
3. No VSCode integration yet, but it's planned

For C# developers


You are free to fork and build your own modifications! My requirement is that any "author" fields in C# code are allowed to be supplemented only(!).

How to build


Code: 
dotnet publish -c Release --self-contained --runtime win10-x64 /property:Version=YOUR_VERSION
dotnet publish -c Release --self-contained --runtime win-x86 /property:Version=YOUR_VERSION

ScorpioT1000 © 2019
Contents

WLPM 0.7-beta (Binary)

Size
39.16 MB
Uploaded
Jun 6, 2019
Updated
Never
Download

G_Freak45

G_Freak45

G_Freak45

Level 2
Joined
Jan 27, 2011
Messages
11
Reactive Extension for Warcraft 3 Lua
I used this for RxW3

Some feedback:
Need package initialization to set things like "sources" in the wlpm-package.json
Need to be able to use local packages. I would like to do some integration testing of RxW3 without pushing to github publicly
I would like to be able to compose packages, IE: Declare a piece of a package in another file like the operators section of RxW3
Need better documentation on what can go in the wlpm-package.json
 

eejin

eejin

eejin

Tool Moderator
Level 12
Joined
Mar 6, 2017
Messages
234
Installing went fine. I'd prefer a portable executable that I would add to the system path myself, but I guess this might be easier for inexperienced users.

Trying to install your demo package 1.0 gave me an error:
upload_2020-5-11_12-42-54.png

Installing 1.1 does seem to work.


Trying to install packages with .git at the end of the URL will fail
upload_2020-5-11_12-40-37.png

Trying to install the package without the .git at the end will then also fail
upload_2020-5-11_12-40-47.png

If you then delete ".wlpm" and "wlpm-package.json" it will install fine again.


I also couldn't get the demo package working. It would install, but then if I tried to use it my map would no longer launch. You can find the map attached with the 2 demo lines in the map script header. I'm setting this to Awaiting Update for now.
 

Attachments

  • Luatest.w3x.zip
    24.3 KB · Views: 126

eejin

eejin

eejin

Tool Moderator
Level 12
Joined
Mar 6, 2017
Messages
234
Ok so I figured that you can't use the WE for scripting, but have to do it all directly in war3map.lua which isn't a big issue, but it would be nice if it was mentioned.
You also have to then run build after every time you save with the WE as it will overwrite your war3map.lua. Your feature lists says you have some kind of C# watcher in the Module Manager to do this automatically, but I don't see any .exes or .cs files in there. I'm also unsure why it is separate and not included with WLPM by default.

I also get this error when I paste your demo-hello example code in the war3map.lua, but I have it installed and it is listed in the wlpm-package.json as a dependency.
upload_2020-6-1_10-45-30.png


A step by step guide on installation and first package use with a paragraph on expected workflow would be really helpful.
 
You must log in or register to reply here.

Similar threads

Jampion
  • Locked
Lua Submission Rules Discussion
Replies
8
Views
2K
Jampion
Jampion
ScorpioT1000
[Lua] [Needs Fix] eventDispatcher
Replies
5
Views
2K
ScorpioT1000
ScorpioT1000
G_Freak45
Reactive Extension for Warcraft 3 Lua
Replies
3
Views
5K
G_Freak45
G_Freak45
netd777
  • Locked
Simple node.js Lua map bundling template
Replies
0
Views
1K
netd777
netd777
actboy168
  • Locked
A Lua Engine for Warcraft 3
Replies
9
Views
9K
actboy168
actboy168
Top