v1.0.0

.gitignore

@@ -15,6 +15,7 @@ sourcemap.json
 /node_modules
 /package-lock.json
 
+
 # FastCast2 related stuff
 /src/*.legacy.luau
 .aider*
@@ -24,4 +25,4 @@ sourcemap.json
 
 # Development related stuff
 DevPackages
-build
+build

CONTRIBUTING.md

@@ -17,8 +17,6 @@ This project is open-source and community-driven, and **all kinds of help are we
    - Commit your changes
    - Push to your fork
    - Open a **Pull Request** against the `main` branch
-   - You must provide **RBXM** file to the author for release (Optional) <br>
-   > (Only if the author aka **Mawin_CK** himself requested you to provide **RBXM** for the release)
 
 All pull requests will go through **code review** before merging.
 
@@ -33,7 +31,7 @@ All pull requests will go through **code review** before merging.
 ### Commit Message Guidelines
 
 Examples:
-- `fix: prevent nil reference in ObjectCache`
+- `fix: prevent nil reference in cast cleanup`
 - `feat: add BulkMoveTo support for parts.`
 - `docs: improve usage example for parallel mode.`
 - `chore: update Luau types in Caster.`
@@ -58,7 +56,9 @@ I'm not strict about changelogs, and I don't really bother writing explicit chan
 - Keep discussions technical and constructive
 
 ### Testing
-- Read manual testing instructions: https://github.com/weenachuangkud/FastCast2/blob/main/TESTS.md
+- Run the automated suite before opening a PR: `npm test` (or `lune run tests/run.luau`)
+- It runs the functional tests and benchmark matrix in Studio and uploads the report to paste.shellworks.dev; see [`tests/README.md`](tests/README.md)
+- Manual checklist / coverage reference: [`TESTS.md`](TESTS.md)
 
 ### Questions?
 

README.md

@@ -45,69 +45,70 @@ Because FastCast is no longer actively maintained by [EtiTheSpirit](https://gith
 - Raycast and Blockcast, Spherecast support
 - BulkMoveTo/Motor6D support
 - Built-in castVisualization
-- Built-in ObjectCache
 - Built-in HighFidelitySegment control
-- Flexible and extensible design
+- Flexible, extensible
 - High Performance
 
-FastCast2 is an open-source project, and contributions from the community are welcome. <br />
-Read more on [FastCast2 devforum](https://devforum.roblox.com/t/fastcast2-an-improved-version-of-fastcast-with-parallel-scripting-more-extensions-and-statically-typed/4093890)
+FastCast2 is an open-source project, and contributions from the community are welcome — see [Contributing](#contributing) below.
 
 ---
-# Installation guide
+## Installation guide
 
 
-1. Go to [Releases](https://github.com/weenachuangkud/FastCast2/releases) and install the `.rbxm` file from the latest release.
+### 1. Model file (.rbxm)
+
+1. Go to [Releases](https://github.com/weenachuangkud/FastCast2/releases) and download the `.rbxm` file from the latest release.
 2. Open Roblox Studio and open any project.
 3. Go to **File → Import Roblox Model** and import the `.rbxm` file.
 4. After importing, **FastCast2** will appear in your Workspace.
 5. Drag **FastCast2** into **ReplicatedStorage**.
-6. Done, and you’re ready to use FastCast2.
-
----
-
-## Install with [Wally](https://wally.run/)
-
-1. Make you have installed Wally: https://wally.run/install
-2. After you've installed Wally, make sure to `wally init`
-3. Then inside `wally.toml` below `[dependencies]` copy and paste `FastCast2 = "weenachuangkud/fastcast2@0.1.4"`
-4. Run `wally install`, and you're ready to use
-
-NOTE: This does not include rojo setup
+6. Done — you're ready to use FastCast2.
+
+### 2. Install with [Wally](https://wally.run/)
+
+1. Make sure you have [Wally installed](https://wally.run/install).
+2. Run `wally init` if you haven't already.
+3. Add FastCast2 under `[dependencies]` in your `wally.toml`:
+```toml
+   FastCast2 = "weenachuangkud/fastcast2@0.1.4"
+```
+
+4. Run `wally install` and you're ready to use it.
+> **Note:** This does not include a Rojo setup, you'll need your own `default.project.json` to sync `Packages` into your place.
 
 ---
 
-# Code example
-
-Shooting projectiles from your head (Serial mode - simpler, main thread):
-
+## Quick start
+ 
+Shooting projectiles from your head (Serial mode, simpler, runs on the main thread):
+ 
 ```lua
 -- Services
 local Rep = game:GetService("ReplicatedStorage")
 local Players = game:GetService("Players")
-
+ 
 -- Requires
 local FastCast2 = require(Rep:WaitForChild("FastCast2"))
 local FastCastEnums = require(Rep:WaitForChild("FastCast2"):WaitForChild("FastCastEnums"))
-
+ 
 -- CONSTANTS
 local SPEED = 500
-
+ 
 -- Variables
 local player = Players.LocalPlayer
 local character = player.Character or player.CharacterAdded:Wait()
 local Head = character:WaitForChild("Head")
 local Mouse = player:GetMouse()
-
+ 
 local ProjectileContainer = workspace:WaitForChild("Projectiles")
 local ProjectileTemplate = Rep:WaitForChild("Projectile")
-
+ 
 -- CastParams
 local CastParams = RaycastParams.new()
 CastParams.FilterDescendantsInstances = {character}
 CastParams.FilterType = Enum.RaycastFilterType.Exclude
 CastParams.IgnoreWater = true
-
+ 
 -- Behavior (FastCastBehavior)
 local behavior = FastCast2.newBehavior()
 behavior.MaxDistance = 1000
@@ -117,24 +118,23 @@ behavior.HighFidelitySegmentSize = 1
 behavior.Acceleration = Vector3.new(0, -workspace.Gravity/2.3, 0)
 behavior.CosmeticBulletContainer = ProjectileContainer
 behavior.CosmeticBulletTemplate = ProjectileTemplate
-
-
+
 -- Serial Caster (runs on main thread, simpler)
 local Caster = FastCast2.new()
-Caster:Init("BulkMoveTo", false) -- movementMode, useObjectCache
-
+Caster:Init("BulkMoveTo") -- movementMode
+ 
 -- Events (can be set before Init)
 Caster.Hit = function(cast, result, velocity, bullet)
 	print("Hit: " .. result.Instance.Name)
 end
-
+ 
 -- Fire
 local function fire()
 	local origin = Head.Position
 	local direction = (Mouse.Hit.Position - origin).Unit
 	Caster:RaycastFire(origin, direction, SPEED, behavior)
 end
-
+ 
 -- Input
 game:GetService("UserInputService").InputBegan:Connect(function(input, gameProcessed)
 	if gameProcessed then return end
@@ -145,63 +145,52 @@ end)
 ```
 
 ### Blockcast & Spherecast
-
-Swap `RaycastFire` for `BlockcastFire` or `SpherecastFire` to change cast type:
-
+ 
+Swap `RaycastFire` for `BlockcastFire` or `SpherecastFire` to change the cast type:
+ 
 ```lua
 -- Blockcast: pass a Vector3 size after origin
 Caster:BlockcastFire(origin, Vector3.new(2, 4, 2), direction, SPEED, behavior)
-
+ 
 -- Spherecast: pass a number radius after origin
 Caster:SpherecastFire(origin, 3, direction, SPEED, behavior)
 ```
 
-### ObjectCache (Or object pooling)
+### Cosmetic bullets
 
-ObjectCache reuses cosmetic bullet instances instead of creating/destroying them every shot:
+FastCast2 no longer includes a built-in ObjectCache. Manage cosmetic bullet instances yourself and provide them through `behavior.CosmeticBulletTemplate` and `behavior.CosmeticBulletContainer`.
 
-```lua
-local Caster = FastCast2.new()
-Caster:Init("BulkMoveTo", true, ProjectileTemplate, 500, workspace)
---                                    ^template   ^size  ^holder
-```
-
-The cache pre-allocates 500 parts by default, auto-expands when exhausted, and moves retired
-parts to a far-away CFrame via `BulkMoveTo` — no instance creation/destruction overhead.
+FastCast2 also does not automatically destroy or return cosmetic bullets when a cast terminates, so the caller controls their lifecycle.
 
 ### Parallel mode
 
+
 ```lua
 local Caster = FastCast2.newParallel()
 Caster:Init(
 	4,                 -- numWorkers
-	workspace,         -- VM folder parent
-	"FastCastVMs",     -- VM folder name
-	workspace,         -- container parent
-	"VMContainer",     -- container name
-	"VM",              -- VM name
 	"BulkMoveTo",      -- movementMode
 	nil,               -- FastCastEventsModule (optional)
-	false              -- useObjectCache
 )
-
+ 
 -- Events work the same as serial
 Caster.Hit = function(cast, result, velocity, bullet)
 	print("Hit: " .. result.Instance.Name)
 end
-
+ 
 --[[
 	-- Except:
 	-- Caster.CanPierce
 	--> You will have to use FastCastEventsModule for that
 ]]
-
+ 
 -- Fire the same as serial
 Caster:RaycastFire(origin, direction, SPEED, behavior)
 Caster:BlockcastFire(origin, Vector3.new(2, 4, 2), direction, SPEED, behavior)
 Caster:SpherecastFire(origin, 3, direction, SPEED, behavior)
 ```
 
+
 <br />
 
 How to set up [FastCastEventsModule](https://weenachuangkud.github.io/FastCast2/api/TypeDefinitions/#FastCastEventsModule)
@@ -277,7 +266,7 @@ Motor6D mode uses `Motor6D.Transform` for more performance instead of `BulkMoveT
 
 ```lua
 local Caster = FastCast2.new()
-Caster:Init("Motor6D", false) -- movementMode = "Motor6D"
+Caster:Init("Motor6D") -- movementMode = "Motor6D"
 ```
 
 All active casts automatically get a Motor6D connection on registration and disconnection on cleanup.
@@ -288,6 +277,18 @@ Caster:SetMovementModeEnabled(true, "Motor6D")   -- enable Motor6D
 Caster:SetMovementModeEnabled(true, "BulkMoveTo") -- switch back
 ```
 
+### Simulation configuration
+
+Simulation behavior can be configured in `src/Config.luau`:
+
+```lua
+Config.SimulationMode = "PerFrame" -- or "Fixed"
+Config.FixedSimulationFrequency = Enum.StepFrequency.Hz60
+Config.CosmeticUpdateInterval = 3
+```
+
+`PerFrame` uses `PreSimulation` on the client and `Heartbeat` on the server. `Fixed` uses `RunService:BindToSimulation()` at the configured step frequency. `CosmeticUpdateInterval` controls how often cosmetic bullet movement is applied; hit detection still runs every simulation step.
+
 ### Cast manipulation
 
 Modify active casts at runtime using the static `FastCast` methods:
@@ -316,11 +317,33 @@ FastCast2:TerminateCast(cast)
 
 ### -> Get started with the [FastCast2 documentation](https://weenachuangkud.github.io/FastCast2/docs/api-reference)
 
+---
+
+## Contributing
+
+FastCast2 is community-driven, and contributions of all kinds are welcome, code, documentation, bug reports, examples, or ideas.
+
+1. Found a bug or have an idea? Open an [Issue](https://github.com/weenachuangkud/FastCast2/issues) first.
+2. Want to submit code or docs? Fork the repo, branch off `main`, make your changes, and open a Pull Request.
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the full guide and [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) for community expectations.
+
+<br>
+
+
+## Benchmarks
+
+FastCast2 includes repeatable client and server benchmarks for raycasts, blockcasts, and spherecasts. They compare serial and parallel execution using creation/cleanup throughput and simulation frame-time percentiles. See the [benchmark guide](benchmarks/README.md) for controls and the ready-to-sync Rojo project.
+
+## Tests
+
+The automated suite runs the functional tests and the six-case benchmark matrix inside Roblox Studio, prints a Markdown results table, and uploads the report to [paste.shellworks.dev](https://paste.shellworks.dev). Run it with `npm test` (or `lune run tests/run.luau`). See the [test guide](tests/README.md) for prerequisites and flags.
+
+
 ---
 
 # People behind FastCast2(Contributors)
 - [CK06](https://github.com/weenachuangkud): Main developer, Maintainer, Graphic designer
-- [Naymmmm](https://github.com/Naymmmm): Maintainer (Inactive)
+- [Naymmmm](https://github.com/Naymmmm): Maintainer
 - [EtiTheSpirit](https://github.com/EtiTheSpirit): Original developer
 - [Per2iako](https://github.com/Per2iako): Maintainer
 
@@ -342,5 +365,4 @@ More broadly, this community feedback has played a significant role in FastCast2
 - [90gq31](https://computerunion.miraheze.org/90gq31) — Giving me the opportunity to be part of the community
 
 # Dependency
-- [ObjectCache](https://devforum.roblox.com/t/objectcache-a-modern-blazing-fast-model-and-part-cache/3104112)
 - [VMsDispatcher](https://github.com/weenachuangkud/VMsDispatcher)