A pause in the active development of the Vexon

  An Important Update on the Vexon Language Project It is with a heavy heart that we are announcing a pause in the active development of the...

Monday, 8 December 2025

How to Publish Your Own Vexon Packages to VXPM

 

📦 How to Publish Your Own Vexon Packages to VXPM (The Complete Guide)

VXPM (Vexon Package Manager) is a simple but powerful way to share Vexon scripts, tools, and extensions with the community.
But how do you publish your own package so others can install it through VXPM?

This guide walks you through step-by-step:

  • How to structure your package

  • How to create the required files

  • How to zip it correctly

  • How to publish it by sending an email

  • What happens after publishing

Let’s get started! 🚀


1. What Counts as a VXPM Package?

A VXPM package is simply a ZIP file that contains two files:

mycoolpackage.vx mycoolpackage-example.vx

These two files let VXPM know how to install and run your script.
Alongside these, you must include an about.txt file:

about.txt

This is displayed when users run:

vxpm> look-up mycoolpackage

📁 2. Required Folder Structure

Before creating the ZIP, your folder must look like this:

MyCoolPackage/ │ ├── mycoolpackage.vx ├── mycoolpackage-example.vx └── about.txt

mycoolpackage.vx

This is the main script.

mycoolpackage-example.vx

This is a demo or usage example.
Include basic usage like:

import mycoolpackage; print(runDemo());

about.txt

This file describes your package. Example:

MyCoolPackage A Vexon utility for generating adventure maps. Author: YourName Version: 1.0.0 Released: 2025-12-09 Includes: - Main script - Example script

Make this file clear and simple. VXPM will show this to users.


🔧 3. Packaging Your Files (Correctly)

Once your folder is ready:

Option A – Windows (Right click)

  1. Select your 3 files (*.vx and about.txt)

  2. Right-click → Send toCompressed (zipped) folder

  3. Name the ZIP file exactly as your package name:

mycoolpackage.zip

Option B – Using Python

import zipfile files = ["mycoolpackage.vx", "mycoolpackage-example.vx", "about.txt"] with zipfile.ZipFile("mycoolpackage.zip", "w") as z: for f in files: z.write(f)

IMPORTANT RULES

  • ZIP name must match the package name

  • No nested folders inside the ZIP

  • Only these three files should be inside


✉️ 4. Publishing Your Package to VXPM

Once your ZIP file is ready:

Send an email to:

📩 vexonlang+vxpm@outlook.com


Email Format Example

Subject:

VXPM Package: MyCoolPackage

Body:

Hello! I want to publish a new VXPM package. Package Name: MyCoolPackage Author: YourName Description: A demo package that generates adventure maps. Version: 1.0.0 Thanks!

Attach:

mycoolpackage.zip

📨 5. What Happens After You Email the ZIP?

  1. The VXPM moderation checks:
    ✔ ZIP structure
    ✔ Required files
    ✔ No harmful content
    ✔ Proper naming

  2. Once approved:

    • The package is uploaded to the official VXPM Discord channel.

    • It becomes instantly available to install with:

vxpm> install mycoolpackage
  1. Users can now look it up:

vxpm> look-up mycoolpackage

Your about.txt is shown.


🚀 6. Best Practices for VXPM Packages

✔ Use lowercase names

mycoolpackage.vx

✔ Keep example simple

Show only the basic usage.

✔ Keep about.txt informative but short

Include:

  • What it does

  • Your name

  • Version

  • Requirements (if any)

✔ Test your ZIP before sending

Try installing it yourself in VXPM.


🎉 Conclusion

Publishing a VXPM package is extremely simple:

  1. Create 3 files (.vx, -example.vx, about.txt)

  2. Zip them into packagename.zip

  3. Email it to vexonlang+vxpm@outlook.com

  4. Wait for it to go live

You’re now officially contributing to the Vexon ecosystem!
Whether you’re building tools, game logic, libraries, or fun utilities, VXPM makes sharing easy.

No comments:

Post a Comment