docs upgate

This commit is contained in:
2025-07-02 23:04:33 -07:00
parent 654451e3d2
commit 62a88446df
6 changed files with 24 additions and 27 deletions
+7 -8
View File
@@ -8,14 +8,14 @@ Complete reference for all EasyBallistics classes, functions, and events.
| Class | Description | Module |
|-------|-------------|---------|
| [`AEBBullet`](bullet-actor) | Main projectile actor with physics simulation | Runtime |
| `AEBBullet` | Main projectile actor with physics simulation | Runtime |
### Components
| Class | Description | Module |
|-------|-------------|---------|
| [`UEBBarrel`](barrel-component) | Weapon barrel with firing mechanics | Runtime |
| [`UEBBallisticImpactComponent`](impact-component) | Impact handling and event system | Runtime |
| `UEBBarrel` | Weapon barrel with firing mechanics | Runtime |
| `UEBBallisticImpactComponent` | Impact handling and event system | Runtime |
### Assets
@@ -29,7 +29,7 @@ Complete reference for all EasyBallistics classes, functions, and events.
| Class | Description | Module |
|-------|-------------|---------|
| [`UEBMathematicalBallistics`](mathematical-ballistics) | Static calculation functions | Runtime |
| `UEBMathematicalBallistics` | Static calculation functions | Runtime |
## Enumerations
@@ -359,7 +359,6 @@ When migrating from the old impact system:
## See Also
- [Component API Reference](bullet-actor) - Detailed component documentation
- [Events Reference](events) - Complete event system documentation
- [Mathematical Formulas](../mathematical/penetration-calculations) - Physics calculation details
- [Migration Guide](../migration/new-impact-system) - Upgrading from legacy system
- [Core Concepts](../core-concepts/overview) - System architecture overview
- [Quick Start Guide](../getting-started/quick-start) - Create your first weapon
- [Troubleshooting](../troubleshooting) - Common issues and solutions
+3 -4
View File
@@ -256,7 +256,6 @@ Content/
Now that you understand the core concepts:
1. [Asset Types](asset-types) - Deep dive into each asset type
2. [Ballistics System](ballistics-system) - Detailed physics explanations
3. [Physical Materials](physical-materials) - Material system integration
4. [Component Guide](../components/bullet-actor) - Component-specific documentation
1. [API Reference](../api/overview) - Detailed function documentation
2. [Quick Start Guide](../getting-started/quick-start) - Create your first weapon
3. [Troubleshooting](../troubleshooting) - Common issues and solutions
+4 -4
View File
@@ -56,7 +56,7 @@ git submodule update --init --recursive
4. Check the **Enabled** checkbox
5. Click **Restart Now** when prompted
![Plugin Manager](../img/plugin-manager.png)
![Plugin Manager](https://placehold.co/800x400/2e8555/white?text=Plugin+Manager+Screenshot)
## Verifying Installation
@@ -74,7 +74,7 @@ git submodule update --init --recursive
- Bullet Properties
- Material Response Map
![Asset Creation Menu](../img/asset-creation-menu.png)
![Asset Creation Menu](https://placehold.co/600x400/2e8555/white?text=Asset+Creation+Menu)
### Verify Components
@@ -145,8 +145,8 @@ PublicDependencyModuleNames.AddRange(new string[] {
Once installation is complete:
1. [Quick Start Guide](quick-start) - Create your first ballistic weapon
2. [Basic Setup](basic-setup) - Configure materials and responses
3. [Core Concepts](../core-concepts/overview) - Understand the system architecture
2. [Core Concepts](../core-concepts/overview) - Understand the system architecture
3. [API Reference](../api/overview) - Detailed function documentation
## Getting Help
+5 -6
View File
@@ -43,7 +43,7 @@ Penetration:
Expansion Velocity Threshold: 1800.0
```
![Bullet Properties](../img/bullet-properties-setup.png)
![Bullet Properties](https://placehold.co/800x600/2e8555/white?text=Bullet+Properties+Editor)
## Step 2: Set Up Physical Materials
@@ -235,13 +235,12 @@ After completing this setup, you should have:
Now that you have a basic system working:
1. [Asset Creation Guide](../assets/bullet-properties) - Create more bullet types
2. [Material Setup](../assets/physical-material-integration) - Advanced material configuration
3. [Advanced Ballistics](../tutorials/advanced-ballistics) - Atmospheric effects and drag curves
4. [Networking](../networking/overview) - Set up multiplayer ballistics
1. [Core Concepts](../core-concepts/overview) - Understand the system architecture
2. [API Reference](../api/overview) - Detailed function documentation
3. [Troubleshooting](../troubleshooting) - Common issues and solutions
## Getting Help
- Join our [Discord](https://discord.gg/easyballistics) for real-time help
- Check the [API Reference](../api/overview) for detailed function documentation
- Browse [Tutorials](../tutorials/first-weapon) for more advanced setups
- Browse the [Troubleshooting Guide](../troubleshooting) for common issues
+1 -1
View File
@@ -67,7 +67,7 @@ graph TD
1. [Installation Guide](getting-started/installation) - Install the plugin
2. [Quick Start](getting-started/quick-start) - Create your first weapon
3. [Basic Setup](getting-started/basic-setup) - Configure materials and responses
3. [Core Concepts](core-concepts/overview) - Understand the system architecture
## Support
+4 -4
View File
@@ -23,7 +23,7 @@ const config = {
organizationName: 'mookie', // Usually your GitHub org/user name.
projectName: 'easyballistics', // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
// Even if you don't use internationalization, you can use this field to set
@@ -98,11 +98,11 @@ const config = {
items: [
{
label: 'Getting Started',
to: '/getting-started',
to: '/getting-started/installation',
},
{
label: 'API Reference',
to: '/api',
to: '/api/overview',
},
],
},
@@ -138,7 +138,7 @@ const config = {
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
additionalLanguages: ['cpp', 'blueprint'],
additionalLanguages: ['cpp', 'bash', 'yaml', 'ini'],
},
}),
};