readme.md

BlitzMax for Visual Studio Code

Welcome to the BlitzMax extension for Visual Studio Code!
If you are new to BlitzMax or VS Code, make sure you read how to get started.

This extension provides the following features inside VS Code for BlitzMax source files:

• Built-in documentation, examples and help
• Language Server Protocol *
• Easy quick build buttons
• Syntax highlighting
• Build options view
• Problem matcher
• Formatting *
• Debugging
• Snippets

You can discuss this extension on Discord:
We hang out in the #vscode-extension channel!

Get started writing BlitzMax code in VS Code

---

• Step by step guide - A guide to installing and compiling your first application.
• Extension FAQ - Make sure you read this first.
• BlitzMax NG - Everything you need to start using BlitzMax NG.
• VS Code Introduction - Videos on how to get started with VS Code.
• Basics Editing - Learn about highly productive source code editing.
• Debugging - All you need to know about debugging.
• Tasks - Get things done quicker with tasks.
• Guide to tasks - A guide to using tasks specifically with BlitzMax NG.

Changelog

---

See CHANGELOG.

Note about using the Language Server Protocol

---

A "LSP" server is an external application that monitors your project and source code.
It can provide linting and very accurate auto-complete suggestions, among many other things.

You will have to provide (or write) your own LSP server.
A work in progress LSP server can be found here.

Useful LSP links for server developers:
VS Code specific information
Official LSP specifications

Note about using formatting

---

Formatting is currently handled externally.
You will have to install a BlitzMax specific formatter.
(Unless your LSP server handles it)

The extension will guide you through this process on the first format.

FAQ

---

• Q. What languages are supported?

  • A. Only BlitzMax NG is officially supported.
    You can enable the 'Legacy Mode' build option for basic BlitzMax Vanilla/Legacy build support.
    (I highly recommend you upgrade to BlitzMax NG)

• Q. Why is the outlines view and breadcrumbs not working?

  • A. These features are provided by the LSP server.
    Make sure your current LSP supports these features.

• Q. I've found an issue / I'd like to make a feature request, what do I do?

  • A. Is the issue or request already listed at GitHub Issues?
    If not, you can open up a new GitHub issue here.

• Q. How do I <do this or that> in VS Code?
  (aka. I need more help)

  • A. For general questions or VS Code related help you have few options:

    1. Read Get started writing BlitzMax code in VS Code.

    2. Use our GitHub Discussions board.

    3. Visit our #vscode-extension channel on Discord:

Credits

---

BlitzMax by Mark Sibly.
BlitzMax NG by Brucey.
Extension by Hezkore.
Icons by GWRon.

Contributing

---

Contributions are greatly appreciated.
Fork this repository and open your pull requests.

License

---

Licensed under the MIT License.