Spearhead/spearhead
3
0
Fork 0
Code Issues 20 Pull Requests Actions Packages Releases 2 Wiki Activity

Feature/automation #6

Merged
dutchie031 merged 39 commits from feature/automation into main 2026-07-30 12:26:55 +00:00
Conversation 0 Commits 39 Files Changed 19
+671 -498
19 changed files with 671 additions and 498 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.docs/web/img/first-start/1.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 330 KiB

.docs/web/index.html
+14 -19
View File
@@ -32,28 +32,23 @@
<div class="content-wrapper"> <div class="content-wrapper">
<h1 id="welcome">Welcome to Spearhead!</h1> <h1 id="welcome">Welcome to Spearhead!</h1>
<p>Welcome to the story teller friendly mission framework in DCS (at least, that's what we hope to create).</p>
<p>Together with mission editors we've tried to build a framework that makes creating multiplayer missions as easy as possible.
With the help of naming conventions, trigger zones, pre-configured logic and custom configuration items, it gives a huge amount of versatility.
we're trying to strike a balance between no-code and low-code with the possibility to hook into it for the hard core scripters (like ourselves).
<note-box type="info">
<b>For the scripters</b>: If you yourself are a scripter, and you're missing interfaces, please reach out to us! We want to make sure that the framework is as easy to use for scripters as it is for non-scripters, and we can't do that without your help!
</note-box>
</p>
<p>
Whether this is your first mission or your hundredth, we hope Spearhead will make your life easier.
</p>
<download-spearhead></download-spearhead>
<p>Welcome to the story teller friendly mission framework in DCS (at least, that's what we hope to create).</p>
<p>Together with mission editors we've tried to build a framework that
makes creating multiplayer missions as easy as possible.
With the help of naming conventions, trigger zones, pre-configured
logic and custom configuration items, it gives a huge amount of versatility.
we're trying to strike a balance between no-code and low-code with the possibility to hook into it for
the hard core scripters.
</p>
<p>
Whether this is your first mission or your hundredth, we hope Spearhead will make your life easier.
</p>
<download-spearhead></download-spearhead>
</div> </div>
</div> </div>
</main> </main>
<footer> <footer>
.docs/web/js/components/code-block.js
+29 -29
View File
@@ -1,29 +1,29 @@
class CodeBlock extends HTMLElement { class CodeBlock extends HTMLElement {
connectedCallback() { connectedCallback() {
// Get the code content as text, preserving whitespace // Get the code content as text, preserving whitespace
let code = this.textContent.replace(/\r\n?/g, "\n"); let code = this.textContent.replace(/\r\n?/g, "\n");
// Remove leading/trailing blank lines // Remove leading/trailing blank lines
code = code.replace(/^\s*\n/, '').replace(/\n\s*$/, ''); code = code.replace(/^\s*\n/, '').replace(/\n\s*$/, '');
// Find leading spaces from the first non-empty line // Find leading spaces from the first non-empty line
const lines = code.split("\n"); const lines = code.split("\n");
const firstLine = lines.find(line => line.trim().length > 0) || ''; const firstLine = lines.find(line => line.trim().length > 0) || '';
const leadingSpaces = firstLine.match(/^\s*/)[0].length; const leadingSpaces = firstLine.match(/^\s*/)[0].length;
// Remove that many leading spaces from all lines // Remove that many leading spaces from all lines
const stripped = lines.map(line => line.slice(leadingSpaces)).join("\n"); const stripped = lines.map(line => line.slice(leadingSpaces)).join("\n");
// Escape HTML special characters // Escape HTML special characters
const escaped = stripped const escaped = stripped
.replace(/&/g, "&amp;") .replace(/&/g, "&amp;")
.replace(/</g, "&lt;") .replace(/</g, "&lt;")
.replace(/>/g, "&gt;"); .replace(/>/g, "&gt;");
const lang = this.getAttribute('lang') || ''; const lang = this.getAttribute('lang') || '';
const langClass = lang ? `language-${lang}` : ''; const langClass = lang ? `language-${lang}` : '';
this.innerHTML = `<pre class=\"custom-code-block\"><code class=\"${langClass}\">${escaped}</code></pre>`; this.innerHTML = `<pre class=\"custom-code-block\"><code class=\"${langClass}\">${escaped}</code></pre>`;
// If Prism or highlight.js is present, trigger highlighting // If Prism or highlight.js is present, trigger highlighting
if (window.Prism && Prism.highlightElement) { if (window.Prism && Prism.highlightElement) {
Prism.highlightElement(this.querySelector('code')); Prism.highlightElement(this.querySelector('code'));
} else if (window.hljs && hljs.highlightElement) { } else if (window.hljs && hljs.highlightElement) {
hljs.highlightElement(this.querySelector('code')); hljs.highlightElement(this.querySelector('code'));
} }
} }
} }
customElements.define('code-block', CodeBlock); customElements.define('code-block', CodeBlock);
.docs/web/js/components/code-inline.js
+32 -32
View File
@@ -1,32 +1,32 @@
class CodeInline extends HTMLElement { class CodeInline extends HTMLElement {
connectedCallback() { connectedCallback() {
// Get the code content as text // Get the code content as text
let code = this.textContent; let code = this.textContent;
// Escape HTML special characters // Escape HTML special characters
code = code code = code
.replace(/&/g, "&amp;") .replace(/&/g, "&amp;")
.replace(/</g, "&lt;") .replace(/</g, "&lt;")
.replace(/>/g, "&gt;"); .replace(/>/g, "&gt;");
// Highlight variables: $variable, {variable}, or %variable% // Highlight variables: $variable, {variable}, or %variable%
code = code.replace(/(\$[a-zA-Z_][\w]*)|(\{[^\}]+\})|(%[^%]+%)/g, match => code = code.replace(/(\$[a-zA-Z_][\w]*)|(\{[^\}]+\})|(%[^%]+%)/g, match =>
`<span class="inline-var">${match}</span>` `<span class="inline-var">${match}</span>`
); );
// Get language attribute for potential syntax highlighting // Get language attribute for potential syntax highlighting
const lang = this.getAttribute('lang') || ''; const lang = this.getAttribute('lang') || '';
const langClass = lang ? `language-${lang}` : ''; const langClass = lang ? `language-${lang}` : '';
this.innerHTML = `<code class="custom-inline-code ${langClass}">${code}</code>`; this.innerHTML = `<code class="custom-inline-code ${langClass}">${code}</code>`;
// If Prism or highlight.js is present, trigger highlighting // If Prism or highlight.js is present, trigger highlighting
if (window.Prism && Prism.highlightElement) { if (window.Prism && Prism.highlightElement) {
Prism.highlightElement(this.querySelector('code')); Prism.highlightElement(this.querySelector('code'));
} else if (window.hljs && hljs.highlightElement) { } else if (window.hljs && hljs.highlightElement) {
hljs.highlightElement(this.querySelector('code')); hljs.highlightElement(this.querySelector('code'));
} }
} }
} }
customElements.define('code-inline', CodeInline); customElements.define('code-inline', CodeInline);
.docs/web/js/components/latest-version-download.js
+3 -3
View File
@@ -38,7 +38,7 @@ class DownloadScript extends HTMLElement {
} }
try { try {
const response = await fetch('https://api.github.com/repos/dutchie031/Spearhead/releases/latest'); const response = await fetch('https://git.dutchie031.com/api/v1/repos/Spearhead/spearhead/releases/latest');
const data = await response.json(); const data = await response.json();
// Cache the data // Cache the data
@@ -66,7 +66,7 @@ class DownloadScript extends HTMLElement {
var version = "?"; var version = "?";
var timestamp = "?"; var timestamp = "?";
var size = "?"; var size = "?";
var href = "https://github.com/dutchie031/Spearhead/releases" var href = "https://git.dutchie031.com/Spearhead/spearhead/releases"
const latestRelease = await this.fetchLatestRelease(); const latestRelease = await this.fetchLatestRelease();
if (latestRelease) { if (latestRelease) {
@@ -105,7 +105,7 @@ class DownloadScript extends HTMLElement {
<p> <p>
<span class="version-text">${version}</span> (${timestamp}) <br> <span class="version-text">${version}</span> (${timestamp}) <br>
<a style="text-decoration: underline;" target="_blank" href="${href}">Download</a> (${size}) <br> <a style="text-decoration: underline;" target="_blank" href="${href}">Download</a> (${size}) <br>
<a style="text-decoration: underline;" target="_blank" href="https://github.com/dutchie031/Spearhead/releases">See All Versions here</a> <a style="text-decoration: underline;" target="_blank" href="https://git.dutchie031.com/Spearhead/spearhead/releases">See All Versions here</a>
</p> </p>
</div> </div>
.docs/web/js/components/note.js
+35 -35
View File
@@ -1,35 +1,35 @@
class Note extends HTMLElement { class Note extends HTMLElement {
connectedCallback() { connectedCallback() {
// Get the note content // Get the note content
const content = this.innerHTML; const content = this.innerHTML;
// Get optional type attribute for different note styles // Get optional type attribute for different note styles
const type = this.getAttribute('type') || 'default'; const type = this.getAttribute('type') || 'default';
// Get optional title attribute // Get optional title attribute
const title = this.getAttribute('title'); const title = this.getAttribute('title');
// Build the note HTML // Build the note HTML
let noteHTML = '<div class="note'; let noteHTML = '<div class="note';
// Add type-specific class if provided // Add type-specific class if provided
if (type !== 'default') { if (type !== 'default') {
noteHTML += ` note-${type}`; noteHTML += ` note-${type}`;
} }
noteHTML += '">'; noteHTML += '">';
// Add title if provided // Add title if provided
if (title) { if (title) {
noteHTML += `<h4 class="note-title">${title}</h4>`; noteHTML += `<h4 class="note-title">${title}</h4>`;
} }
// Add the content // Add the content
noteHTML += content; noteHTML += content;
noteHTML += '</div>'; noteHTML += '</div>';
this.innerHTML = noteHTML; this.innerHTML = noteHTML;
} }
} }
customElements.define('note-box', Note); customElements.define('note-box', Note);
.docs/web/js/components/sidebar.js
+197 -197
View File
@@ -1,198 +1,198 @@
class Sidebar extends HTMLElement { class Sidebar extends HTMLElement {
constructor() { constructor() {
super(); super();
this.navItems = []; this.navItems = [];
} }
connectedCallback() { connectedCallback() {
this.render(); this.render();
this.scanHeaders(); this.scanHeaders();
this.setupScrollListener(); this.setupScrollListener();
this.highlightActiveSection(); this.highlightActiveSection();
} }
scanHeaders() { scanHeaders() {
// Clear existing nav items // Clear existing nav items
this.navItems = []; this.navItems = [];
// Find all h2, h3, and h4 elements with IDs in the content area // Find all h2, h3, and h4 elements with IDs in the content area
const contentWrapper = document.querySelector('.content-wrapper'); const contentWrapper = document.querySelector('.content-wrapper');
if (!contentWrapper) return; if (!contentWrapper) return;
const headers = contentWrapper.querySelectorAll('h2[id], h3[id], h4[id]'); const headers = contentWrapper.querySelectorAll('h2[id], h3[id], h4[id]');
headers.forEach(header => { headers.forEach(header => {
const id = header.getAttribute('id'); const id = header.getAttribute('id');
const text = header.textContent.trim(); const text = header.textContent.trim();
const level = header.tagName.toLowerCase(); const level = header.tagName.toLowerCase();
this.navItems.push({ this.navItems.push({
id, id,
text, text,
level, level,
element: header element: header
}); });
}); });
this.renderNavigation(); this.renderNavigation();
} }
renderNavigation() { renderNavigation() {
const ul = this.querySelector('ul'); const ul = this.querySelector('ul');
if (!ul) return; if (!ul) return;
// Clear existing content // Clear existing content
ul.innerHTML = ''; ul.innerHTML = '';
let currentH2Li = null; let currentH2Li = null;
let currentH3Li = null; let currentH3Li = null;
this.navItems.forEach(item => { this.navItems.forEach(item => {
if (item.level === 'h2') { if (item.level === 'h2') {
// Create h2 item // Create h2 item
const li = document.createElement('li'); const li = document.createElement('li');
const a = document.createElement('a'); const a = document.createElement('a');
a.href = `#${item.id}`; a.href = `#${item.id}`;
a.className = 'side-nav-h2'; a.className = 'side-nav-h2';
a.textContent = item.text; a.textContent = item.text;
a.addEventListener('click', (e) => this.handleNavClick(e, item.id)); a.addEventListener('click', (e) => this.handleNavClick(e, item.id));
li.appendChild(a); li.appendChild(a);
ul.appendChild(li); ul.appendChild(li);
currentH2Li = li; currentH2Li = li;
currentH3Li = null; currentH3Li = null;
} else if (item.level === 'h3' && currentH2Li) { } else if (item.level === 'h3' && currentH2Li) {
// Create h3 item under current h2 // Create h3 item under current h2
let subUl = currentH2Li.querySelector('ul'); let subUl = currentH2Li.querySelector('ul');
if (!subUl) { if (!subUl) {
subUl = document.createElement('ul'); subUl = document.createElement('ul');
currentH2Li.appendChild(subUl); currentH2Li.appendChild(subUl);
} }
const li = document.createElement('li'); const li = document.createElement('li');
const a = document.createElement('a'); const a = document.createElement('a');
a.href = `#${item.id}`; a.href = `#${item.id}`;
a.className = 'side-nav-h3'; a.className = 'side-nav-h3';
a.textContent = item.text; a.textContent = item.text;
a.addEventListener('click', (e) => this.handleNavClick(e, item.id)); a.addEventListener('click', (e) => this.handleNavClick(e, item.id));
li.appendChild(a); li.appendChild(a);
subUl.appendChild(li); subUl.appendChild(li);
currentH3Li = li; currentH3Li = li;
} else if (item.level === 'h4' && currentH3Li) { } else if (item.level === 'h4' && currentH3Li) {
// Create h4 item under current h3 // Create h4 item under current h3
let subUl = currentH3Li.querySelector('ul'); let subUl = currentH3Li.querySelector('ul');
if (!subUl) { if (!subUl) {
subUl = document.createElement('ul'); subUl = document.createElement('ul');
currentH3Li.appendChild(subUl); currentH3Li.appendChild(subUl);
} }
const li = document.createElement('li'); const li = document.createElement('li');
const a = document.createElement('a'); const a = document.createElement('a');
a.href = `#${item.id}`; a.href = `#${item.id}`;
a.className = 'side-nav-h4'; a.className = 'side-nav-h4';
a.textContent = item.text; a.textContent = item.text;
a.addEventListener('click', (e) => this.handleNavClick(e, item.id)); a.addEventListener('click', (e) => this.handleNavClick(e, item.id));
li.appendChild(a); li.appendChild(a);
subUl.appendChild(li); subUl.appendChild(li);
} }
}); });
} }
handleNavClick(e, targetId) { handleNavClick(e, targetId) {
e.preventDefault(); e.preventDefault();
// Remove active class from all links // Remove active class from all links
this.querySelectorAll('a').forEach(link => { this.querySelectorAll('a').forEach(link => {
link.classList.remove('active'); link.classList.remove('active');
}); });
// Add active class to clicked link // Add active class to clicked link
e.target.classList.add('active'); e.target.classList.add('active');
// Smooth scroll to target // Smooth scroll to target
const targetElement = document.getElementById(targetId); const targetElement = document.getElementById(targetId);
if (targetElement) { if (targetElement) {
targetElement.scrollIntoView({ targetElement.scrollIntoView({
behavior: 'smooth', behavior: 'smooth',
block: 'start' block: 'start'
}); });
} }
} }
setupScrollListener() { setupScrollListener() {
let ticking = false; let ticking = false;
const handleScroll = () => { const handleScroll = () => {
if (!ticking) { if (!ticking) {
requestAnimationFrame(() => { requestAnimationFrame(() => {
this.highlightActiveSection(); this.highlightActiveSection();
ticking = false; ticking = false;
}); });
ticking = true; ticking = true;
} }
}; };
window.addEventListener('scroll', handleScroll); window.addEventListener('scroll', handleScroll);
} }
highlightActiveSection() { highlightActiveSection() {
const scrollTop = window.pageYOffset || document.documentElement.scrollTop; const scrollTop = window.pageYOffset || document.documentElement.scrollTop;
const offset = 100; // Offset for highlighting const offset = 100; // Offset for highlighting
let activeId = ''; let activeId = '';
// Find the currently visible section // Find the currently visible section
this.navItems.forEach(item => { this.navItems.forEach(item => {
const element = item.element; const element = item.element;
const rect = element.getBoundingClientRect(); const rect = element.getBoundingClientRect();
const elementTop = rect.top + scrollTop; const elementTop = rect.top + scrollTop;
if (elementTop <= scrollTop + offset) { if (elementTop <= scrollTop + offset) {
activeId = item.id; activeId = item.id;
} }
}); });
// Update active state // Update active state
this.querySelectorAll('a').forEach(link => { this.querySelectorAll('a').forEach(link => {
link.classList.remove('active'); link.classList.remove('active');
}); });
if (activeId !== nil && activeId !== '') { if (activeId !== nil && activeId !== '') {
const activeLink = this.querySelector(`a[href="#${activeId}"]`); const activeLink = this.querySelector(`a[href="#${activeId}"]`);
if (activeLink) { if (activeLink) {
activeLink.classList.add('active'); activeLink.classList.add('active');
} }
} }
} }
render() { render() {
this.innerHTML = ` this.innerHTML = `
<div class="side-nav"> <div class="side-nav">
<h4 class="side-nav-title"></h4> <h4 class="side-nav-title"></h4>
<ul> <ul>
<!-- Navigation items will be populated automatically --> <!-- Navigation items will be populated automatically -->
</ul> </ul>
</div> </div>
`; `;
} }
// Method to refresh the sidebar when content changes // Method to refresh the sidebar when content changes
refresh() { refresh() {
this.scanHeaders(); this.scanHeaders();
} }
// Method to set the sidebar title // Method to set the sidebar title
setTitle(title) { setTitle(title) {
const titleElement = this.querySelector('.side-nav-title'); const titleElement = this.querySelector('.side-nav-title');
if (titleElement) { if (titleElement) {
titleElement.textContent = title; titleElement.textContent = title;
} }
} }
} }
// Register the custom element // Register the custom element
customElements.define('app-sidebar', Sidebar); customElements.define('app-sidebar', Sidebar);
export default Sidebar; export default Sidebar;
.docs/web/js/prism.js
+10 -10
View File
File diff suppressed because one or more lines are too long
.docs/web/js/site.js
+90 -90
View File
@@ -1,91 +1,91 @@
document.addEventListener('DOMContentLoaded', function() { document.addEventListener('DOMContentLoaded', function() {
const themeToggle = document.getElementById('theme-toggle'); const themeToggle = document.getElementById('theme-toggle');
const sunIcon = document.getElementById('sun-icon'); const sunIcon = document.getElementById('sun-icon');
const moonIcon = document.getElementById('moon-icon'); const moonIcon = document.getElementById('moon-icon');
if (!themeToggle || !sunIcon || !moonIcon) return; if (!themeToggle || !sunIcon || !moonIcon) return;
function setTheme(theme) { function setTheme(theme) {
document.documentElement.setAttribute('data-theme', theme); document.documentElement.setAttribute('data-theme', theme);
localStorage.setItem('theme', theme); localStorage.setItem('theme', theme);
sunIcon.style.display = theme === 'light' ? 'block' : 'none'; sunIcon.style.display = theme === 'light' ? 'block' : 'none';
moonIcon.style.display = theme === 'light' ? 'none' : 'block'; moonIcon.style.display = theme === 'light' ? 'none' : 'block';
} }
themeToggle.addEventListener('click', function() { themeToggle.addEventListener('click', function() {
const current = document.documentElement.getAttribute('data-theme') || 'dark'; const current = document.documentElement.getAttribute('data-theme') || 'dark';
setTheme(current === 'dark' ? 'light' : 'dark'); setTheme(current === 'dark' ? 'light' : 'dark');
}); });
// Initialize // Initialize
const saved = localStorage.getItem('theme') || 'dark'; const saved = localStorage.getItem('theme') || 'dark';
setTheme(saved); setTheme(saved);
// Set side-nav-title to the first h1's text // Set side-nav-title to the first h1's text
var h1 = document.querySelector('.content-wrapper h1'); var h1 = document.querySelector('.content-wrapper h1');
var sideNavTitle = document.querySelector('.side-nav-title'); var sideNavTitle = document.querySelector('.side-nav-title');
if (h1 && sideNavTitle) { if (h1 && sideNavTitle) {
sideNavTitle.textContent = h1.textContent; sideNavTitle.textContent = h1.textContent;
} }
}); });
// Highlight sidenav link on scroll (shared for all pages) // Highlight sidenav link on scroll (shared for all pages)
function setupSideNavHighlight() { function setupSideNavHighlight() {
const navLinks = document.querySelectorAll('.side-nav a'); const navLinks = document.querySelectorAll('.side-nav a');
if (!navLinks.length) return; if (!navLinks.length) return;
const sections = Array.from(navLinks).map(link => { const sections = Array.from(navLinks).map(link => {
const id = link.getAttribute('href').replace('#', ''); const id = link.getAttribute('href').replace('#', '');
return document.getElementById(id); return document.getElementById(id);
}); });
function getHeaderOffset() { function getHeaderOffset() {
const header = document.querySelector('header'); const header = document.querySelector('header');
return header ? header.offsetHeight : 0; return header ? header.offsetHeight : 0;
} }
// Custom scroll on nav click // Custom scroll on nav click
navLinks.forEach((link, i) => { navLinks.forEach((link, i) => {
link.addEventListener('click', function(e) { link.addEventListener('click', function(e) {
const section = sections[i]; const section = sections[i];
if (section) { if (section) {
e.preventDefault(); e.preventDefault();
const headerOffset = getHeaderOffset(); const headerOffset = getHeaderOffset();
const targetY = window.innerHeight * 0.10; const targetY = window.innerHeight * 0.10;
const sectionTop = section.getBoundingClientRect().top + window.scrollY; const sectionTop = section.getBoundingClientRect().top + window.scrollY;
const scrollTo = sectionTop - headerOffset - targetY; const scrollTo = sectionTop - headerOffset - targetY;
window.scrollTo({ top: scrollTo, behavior: 'smooth' }); window.scrollTo({ top: scrollTo, behavior: 'smooth' });
} }
}); });
}); });
function onScroll() { function onScroll() {
const headerOffset = getHeaderOffset(); const headerOffset = getHeaderOffset();
const targetY = window.innerHeight * 0.1; // 30% from the top const targetY = window.innerHeight * 0.1; // 30% from the top
let closestIdx = 0; let closestIdx = 0;
let minDist = Infinity; let minDist = Infinity;
for (let i = 0; i < sections.length; i++) { for (let i = 0; i < sections.length; i++) {
const section = sections[i]; const section = sections[i];
if (section) { if (section) {
const dist = Math.abs(section.getBoundingClientRect().top - headerOffset - targetY); const dist = Math.abs(section.getBoundingClientRect().top - headerOffset - targetY);
if (dist < minDist) { if (dist < minDist) {
minDist = dist; minDist = dist;
closestIdx = i; closestIdx = i;
} }
} }
} }
navLinks.forEach((link, i) => { navLinks.forEach((link, i) => {
if (i === closestIdx) { if (i === closestIdx) {
link.classList.add('active'); link.classList.add('active');
} else { } else {
link.classList.remove('active'); link.classList.remove('active');
} }
}); });
} }
window.addEventListener('scroll', onScroll, { passive: true }); window.addEventListener('scroll', onScroll, { passive: true });
window.addEventListener('resize', onScroll); window.addEventListener('resize', onScroll);
onScroll(); // Initial call onScroll(); // Initial call
} }
// Run on DOMContentLoaded // Run on DOMContentLoaded
if (document.readyState === 'loading') { if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', setupSideNavHighlight); document.addEventListener('DOMContentLoaded', setupSideNavHighlight);
} else { } else {
setupSideNavHighlight(); setupSideNavHighlight();
} }
.docs/web/pages/about_us.html
+4 -2
View File
@@ -37,8 +37,10 @@
Even though, at the time of writing this, I've written every single line of code myself, I could not have done it without the help of these members.<br> Even though, at the time of writing this, I've written every single line of code myself, I could not have done it without the help of these members.<br>
Therefore it's something WE created. Therefore it's something WE created.
Our goal was very simple, make it possible to make big dynamic missions, without having to either give away all control or having to get knee deep into scripting. <br> Our goal was very simple, make it possible to make big dynamic missions, without having to either give away all controll or having to get knee deep into scripting. <br>
We struck a balance. We struck a balance.
</p> </p>
.docs/web/pages/first-start.html
+2 -2
View File
@@ -90,13 +90,13 @@
Missions are also defined by trigger zones. <br> Missions are also defined by trigger zones. <br>
They'll be picked up by Spearhead when named according to the naming convention: <br> They'll be picked up by Spearhead when named according to the naming convention: <br>
<code-inline>MISSION_[Type]_[FreeForm]</code-inline> <br> <code-inline>MISSION_[Type]_[FreeForm]</code-inline> <br>
Where <code-inline>[Type]</code-inline> is the type of mission. <a href="./reference.html#mission-zones">See all</a><br> Where <code-inline>[Type]</code-inline> is the type of mission. <br>
</p> </p>
<h3 id="mission-cas">CAS</h3> <h3 id="mission-cas">CAS</h3>
<p> <p>
Personally CAS is one of my favorite mission types. <br> Personally CAS is one of our favorite mission types. <br>
Mostly because it's easy to set up and creates a truly immersive experience. <br> Mostly because it's easy to set up and creates a truly immersive experience. <br>
</p> </p>
.docs/web/pages/reference.html
+1 -12
View File
@@ -80,22 +80,11 @@
<strong>Example:</strong> <code-inline>MISSION_DEAD_BYRON</code-inline> <strong>Example:</strong> <code-inline>MISSION_DEAD_BYRON</code-inline>
</p> </p>
<p> <p>
Missions are completable objectives with specific types. <br /> Missions are completable objectives with specific types, such as DEAD, BAI, STRIKE, or SAM. <br />
Randomized missions can be defined using the format: <span Randomized missions can be defined using the format: <span
class="inline-lua"><span class="lua-variable">RANDOMMISSION_[Type]_[Name]_[Index]</span></span>. class="inline-lua"><span class="lua-variable">RANDOMMISSION_[Type]_[Name]_[Index]</span></span>.
</p> </p>
<p>
Valid Types:
<ul>
<li>SAM</li>
<li>DEAD</li>
<li>BAI</li>
<li>CAS</li>
<li>STRIKE</li>
</ul>
</p>
<h3 id="cap-routes">CAP Routes</h3> <h3 id="cap-routes">CAP Routes</h3>
<p> <p>
<strong>Format:</strong> <code-inline>CAPROUTE_[routeID]_[Name]</code-inline> <br /> <strong>Format:</strong> <code-inline>CAPROUTE_[routeID]_[Name]</code-inline> <br />
.docs/web/pages/spearheadapi.html
+59 -59
View File
@@ -1,60 +1,60 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en" data-theme="dark"> <html lang="en" data-theme="dark">
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Spearhead API</title> <title>Spearhead API</title>
<link rel="stylesheet" href="/style/prism.css"> <link rel="stylesheet" href="/style/prism.css">
<link rel="stylesheet" href="/style/style.css"> <link rel="stylesheet" href="/style/style.css">
<script src="/js/prism.js"></script> <script src="/js/prism.js"></script>
<script src="/js/site.js"></script> <script src="/js/site.js"></script>
<script type="module" src="../js/components.js"></script> <script type="module" src="../js/components.js"></script>
</head> </head>
<body> <body>
<header> <header>
<app-header></app-header> <app-header></app-header>
</header> <main> </header> <main>
<div class="reference-container"> <div class="reference-container">
<app-sidebar></app-sidebar> <app-sidebar></app-sidebar>
<div class="content-wrapper"> <div class="content-wrapper">
<h1>Spearhead API</h1> <h1>Spearhead API</h1>
<div class="note"> <div class="note">
<p><strong>NOTE:</strong> The Spearhead.API space is only released in the Beta branch at the moment.</p> <p><strong>NOTE:</strong> The Spearhead.API space is only released in the Beta branch at the moment.</p>
</div> </div>
<h2 id="introduction">Introduction</h2> <h2 id="introduction">Introduction</h2>
<p> <p>
The <span class="inline-lua"><span class="lua-variable">Spearhead.API</span></span> space is specifically created to make sure mission makers can interact with the framework. The <span class="inline-lua"><span class="lua-variable">Spearhead.API</span></span> space is specifically created to make sure mission makers can interact with the framework.
</p> </p>
<p> <p>
Simply alter logic, get the current state in Spearhead, and give the whole Mission Editor more control. Simply alter logic, get the current state in Spearhead, and give the whole Mission Editor more control.
</p> </p>
<p> <p>
For example, late activate the entire framework by calling <span class="inline-lua"><span class="lua-function">Spearhead.API.Stages.changeStage</span>(<span class="lua-variable">1</span>)</span> later or on demand and setting the starting config stage to -1 in the Spearhead configuration file. For example, late activate the entire framework by calling <span class="inline-lua"><span class="lua-function">Spearhead.API.Stages.changeStage</span>(<span class="lua-variable">1</span>)</span> later or on demand and setting the starting config stage to -1 in the Spearhead configuration file.
</p> </p>
<h2 id="stages">Stages</h2> <h2 id="stages">Stages</h2>
<pre> <pre>
@@API_CODE@@ @@API_CODE@@
</pre> </pre>
</div> </div>
</div> </div>
</main> </main>
<footer> <footer>
<p>&copy; 2025 Spearhead Project</p> <p>&copy; 2025 Spearhead Project</p>
</footer> </footer>
<style> <style>
.side-nav a.active { .side-nav a.active {
font-weight: bold; font-weight: bold;
color: #4fc3f7; color: #4fc3f7;
} }
</style> </style>
</body> </body>
</html> </html>
.docs/web/style/prism.css
+3 -3
View File
@@ -1,3 +1,3 @@
/* PrismJS 1.30.0 /* PrismJS 1.30.0
https://prismjs.com/download#themes=prism-okaidia&languages=lua */ https://prismjs.com/download#themes=prism-okaidia&languages=lua */
code[class*=language-],pre[class*=language-]{color:#f8f8f2;background:0 0;text-shadow:0 1px rgba(0,0,0,.3);font-family:Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace;font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto;border-radius:.3em}:not(pre)>code[class*=language-],pre[class*=language-]{background:#272822}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#8292a2}.token.punctuation{color:#f8f8f2}.token.namespace{opacity:.7}.token.constant,.token.deleted,.token.property,.token.symbol,.token.tag{color:#f92672}.token.boolean,.token.number{color:#ae81ff}.token.attr-name,.token.builtin,.token.char,.token.inserted,.token.selector,.token.string{color:#a6e22e}.language-css .token.string,.style .token.string,.token.entity,.token.operator,.token.url,.token.variable{color:#f8f8f2}.token.atrule,.token.attr-value,.token.class-name,.token.function{color:#e6db74}.token.keyword{color:#66d9ef}.token.important,.token.regex{color:#fd971f}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help} code[class*=language-],pre[class*=language-]{color:#f8f8f2;background:0 0;text-shadow:0 1px rgba(0,0,0,.3);font-family:Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace;font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto;border-radius:.3em}:not(pre)>code[class*=language-],pre[class*=language-]{background:#272822}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#8292a2}.token.punctuation{color:#f8f8f2}.token.namespace{opacity:.7}.token.constant,.token.deleted,.token.property,.token.symbol,.token.tag{color:#f92672}.token.boolean,.token.number{color:#ae81ff}.token.attr-name,.token.builtin,.token.char,.token.inserted,.token.selector,.token.string{color:#a6e22e}.language-css .token.string,.style .token.string,.token.entity,.token.operator,.token.url,.token.variable{color:#f8f8f2}.token.atrule,.token.attr-value,.token.class-name,.token.function{color:#e6db74}.token.keyword{color:#66d9ef}.token.important,.token.regex{color:#fd971f}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}
.gitea/workflows/update-docs.yml
+89 -5
View File
@@ -5,7 +5,12 @@ on:
branches: branches:
- main - main
paths: paths:
- '_docs/**' - '.docs/**'
env:
DOCKER_REGISTRY: registry.dutchie031.net
DOCKER_IMAGE: spearhead-docs
DOCKER_TAG: latest
jobs: jobs:
## Run replacements and cleanups on the docs ## Run replacements and cleanups on the docs
@@ -17,16 +22,45 @@ jobs:
with: with:
fetch-depth: 0 fetch-depth: 0
## --break-system-packages is used to avoid conflicts with system-installed packages on Ubuntu runners.
- name: Install Python Pygments
run: |
python3 -m pip install --upgrade pip --break-system-packages --no-cache-dir --ignore-installed
pip install pygments --break-system-packages
- name: Highlight API code and update HTML
run: |
pygmentize -f html -l lua -O noclasses,style=monokai src/classes/api/SpearheadApiDoc.lua > .docs/web/pages/temp_api_code.html
# Insert the highlighted code into the placeholder in spearheadapi.html
sed -i '/@@API_CODE@@/r .docs/web/pages/temp_api_code.html' .docs/web/pages/spearheadapi.html
sed -i '/@@API_CODE@@/d' .docs/web/pages/spearheadapi.html
rm .docs/web/pages/temp_api_code.html
- name: Highlight API code and update HTML
run: |
pygmentize -f html -l lua -O noclasses,style=monokai ./config.lua > .docs/web/pages/temp_config_code.html
# Insert the highlighted code into the placeholder in spearheadapi.html
sed -i '/@@CONFIG_CODE@@/r .docs/web/pages/temp_config_code.html' .docs/web/pages/reference.html
sed -i '/@@CONFIG_CODE@@/d' .docs/web/pages/reference.html
rm .docs/web/pages/temp_config_code.html
- name: List files in .docs directory
run: |
echo "Listing files in .docs directory:"
ls -R .docs
- name: Upload spearhead.lua artifact - name: Upload spearhead.lua artifact
uses: actions/upload-artifact@v3 uses: actions/upload-artifact@v3
with: with:
name: spearhead-docs name: spearhead-docs
path: ./.docs/**/* path: |
./.docs/Dockerfile
./.docs/web/**/*
retention-days: 1 retention-days: 1
build-image: build-image:
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: prepare-docs
steps: steps:
# Download prepared pages from the previous job # Download prepared pages from the previous job
@@ -34,11 +68,61 @@ jobs:
uses: actions/download-artifact@v3 uses: actions/download-artifact@v3
with: with:
name: spearhead-docs name: spearhead-docs
path: ./spearhead-docs
- name: DEBUG ls
run: |
ls -R ./spearhead-docs
- name: Build Docker image for docs - name: Build Docker image for docs
run: | run: |
docker build -t spearhead-docs ./_docs docker build -t ${{ env.DOCKER_REGISTRY }}/${{ env.DOCKER_IMAGE }}:${{ env.DOCKER_TAG }} ./spearhead-docs
- name: Push Docker image
run: |
docker push ${{ env.DOCKER_REGISTRY }}/${{ env.DOCKER_IMAGE }}:${{ env.DOCKER_TAG }}
deploy-container:
runs-on: ubuntu-latest
needs: build-image
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Helm
uses: azure/setup-helm@v5
with:
version: 'latest'
id: install
- name: Set up Kubeconfig
run: |
mkdir -p $HOME/.kube
echo "${{ secrets.KUBECONFIG_CONTENT }}" > $HOME/.kube/config
chmod 600 $HOME/.kube/config
cat $HOME/.kube/config
- name: Run Helm upgrade/install
run: |
helm upgrade --install spearhead-docs .helm \
--namespace spearhead-docs \
--create-namespace \
--set image.repository=${{ env.DOCKER_REGISTRY }}/${{ env.DOCKER_IMAGE }} \
--set image.tag=${{ env.DOCKER_TAG }} \
--wait
# - name: 'Deploy'
# uses: deliverybot/helm@v1
# with:
# release: spearhead-docs
# namespace: spearhead-docs
# chart: '.helm'
# value-files: >-
# [
# ".helm/values.yaml"
# ]
# env:
# KUBECONFIG_FILE: ${{ secrets.KUBECONFIG_CONTENT }}
.helm/templates/deployment.yaml
+44
View File
@@ -0,0 +1,44 @@
apiVersion: apps/v1
kind: Deployment
metadata:
name: {{ .Values.app }}
labels:
app: {{ .Values.app }}
namespace: spearhead-docs
spec:
replicas: 1
selector:
matchLabels:
app: {{ .Values.app }}
template:
metadata:
labels:
app: {{ .Values.app }}
spec:
securityContext:
runAsNonRoot: true
runAsUser: 65534
seccompProfile:
type: RuntimeDefault
containers:
- name: {{ .Values.app }}
image: {{ .Values.image.repository }}:{{ .Values.image.tag }}
ports:
- containerPort: {{ .Values.ports.containerPort }}
volumeMounts:
- name: cache
mountPath: /var/cache/nginx
- name: run
mountPath: /var/run
securityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
volumes:
- name: cache
emptyDir: {}
- name: run
emptyDir: {}
.helm/templates/ingress.yaml
View File
.helm/templates/network.yaml
+49
View File
@@ -0,0 +1,49 @@
apiVersion: v1
kind: Service
metadata:
name: {{ .Values.app }}
namespace: spearhead-docs
spec:
selector:
app: {{ .Values.app }}
ports:
- protocol: TCP
port: {{ .Values.ports.servicePort }}
targetPort: {{ .Values.ports.containerPort }}
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: {{ .Values.app }}-ingress
namespace: spearhead-docs
annotations:
kubernetes.io/tls-acme: "true"
cert-manager.io/cluster-issuer: "letsencrypt-prod"
spec:
ingressClassName: nginx
rules:
- host: spearhead.dutchie031.com
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: {{ .Values.app }}
port:
number: {{ .Values.ports.servicePort }}
- host: spearhead.rocks
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: {{ .Values.app }}
port:
number: {{ .Values.ports.servicePort }}
tls:
- hosts:
- spearhead.dutchie031.com
- spearhead.rocks
secretName: spearhead-docs-tls
.helm/values.yaml
+10
View File
@@ -0,0 +1,10 @@
app: spearhead-docs
image:
repository: registry.dutchie031.net/spearhead-docs
tag: latest
ports:
servicePort: 80
containerPort: 80