Skip to content

Commit 8951d7c

Browse files
committed
docs: fix formatting
1 parent bb9cfc4 commit 8951d7c

1 file changed

Lines changed: 26 additions & 32 deletions

File tree

plugins/acp/README.md

Lines changed: 26 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@
2020

2121
---
2222

23-
> **Note:** This plugin is currently undergoing updates. Some features and documentation may change in upcoming releases.
24-
>
25-
> The following aspect(s) are still in progress:
26-
> 1. **Wallet functionality** - Currently, you need to use your own wallet address and private key.
27-
2823
The Agent Commerce Protocol (ACP) plugin is used to handle trading transactions and jobs between agents. This ACP plugin manages:
2924

3025
1. RESPONDING to Buy/Sell Needs, via ACP service registry
@@ -97,19 +92,19 @@ pip install acp-plugin-gamesdk
9792
)
9893
```
9994

100-
> Note:
101-
>
102-
> - Your agent wallet address for your buyer and seller should be different.
103-
> - Speak to a DevRel (Celeste/John) to get a GAME Dev API key
95+
> Note:
96+
>
97+
> - Your agent wallet address for your buyer and seller should be different.
98+
> - Speak to a DevRel (Celeste/John) to get a GAME Dev API key
10499

105-
> To whitelist your wallet:
106-
>
107-
> - Go to [Service Registry](https://acp-staging.virtuals.io/) to whitelist your wallet.
108-
> - Press the "Agent Wallets" button
109-
> ![Agent Wallets Page](../../docs/imgs/agent-wallet-page.png)
110-
> - Whitelist your wallet here:
111-
> ![Whitelist Wallet](../../docs/imgs/whitelist-wallet.png)
112-
> ![Whitelist Wallet](../../docs/imgs/whitelist-wallet-info.png)
100+
> To whitelist your wallet:
101+
>
102+
> - Go to [Service Registry](https://acp-staging.virtuals.io/) to whitelist your wallet.
103+
> - Press the "Agent Wallets" button
104+
> ![Agent Wallets Page](../../docs/imgs/agent-wallet-page.png)
105+
> - Whitelist your wallet here:
106+
> ![Whitelist Wallet](../../docs/imgs/whitelist-wallet.png)
107+
> ![Whitelist Wallet](../../docs/imgs/whitelist-wallet-info.png)
113108

114109
4. (Optional) If you want to use GAME's twitter client with the ACP plugin, you can initialize it by running:
115110
@@ -141,7 +136,6 @@ pip install acp-plugin-gamesdk
141136
142137
5. (Optional) If you want to listen to the `ON_EVALUATE` event, you can implement the `on_evaluate` function.
143138
144-
145139
Evaluation refers to the process where buyer agent reviews the result submitted by the seller and decides whether to accept or reject it.
146140
This is where the `on_evaluate` function comes into play. It allows your agent to programmatically verify deliverables and enforce quality checks.
147141
@@ -180,12 +174,12 @@ pip install acp-plugin-gamesdk
180174
```python
181175
acp_worker = acp_plugin.get_worker()
182176
agent = Agent(
183-
api_key = os.environ.get("GAME_API_KEY"),
184-
name = "<your-agent-name-here>",
185-
agent_goal = "<your-agent-goal-here>",
186-
agent_description = "<your-agent-description-here>"
187-
workers = [core_worker, acp_worker],
188-
get_agent_state_fn = get_agent_state
177+
api_key = os.environ.get("GAME_API_KEY"),
178+
name = "<your-agent-name-here>",
179+
agent_goal = "<your-agent-goal-here>",
180+
agent_description = "<your-agent-description-here>"
181+
workers = [core_worker, acp_worker],
182+
get_agent_state_fn = get_agent_state
189183
)
190184
```
191185
@@ -213,23 +207,23 @@ pip install acp-plugin-gamesdk
213207
state = acp_plugin.get_acp_state()
214208
# Find the job in the active seller jobs that matches the provided jobId
215209
job = next(
216-
(j for j in state.jobs.active.as_a_seller if j.job_id == jobId),
217-
None
210+
(j for j in state.jobs.active.as_a_seller if j.job_id == jobId),
211+
None
218212
)
219213
220214
# If no matching job is found, return an error
221215
if not job:
222-
return FunctionResultStatus.FAILED, f"Job {jobId} is invalid. Should only respond to active as a seller job.", {}
216+
return FunctionResultStatus.FAILED, f"Job {jobId} is invalid. Should only respond to active as a seller job.", {}
223217
224218
# Mock URL for the generated product
225219
url = "https://example.com/meme"
226220
227221
meme = IInventory(
228-
type="url",
229-
value=url,
230-
jobId=job_id,
231-
clientName=job.get("clientName"),
232-
providerName=job.get("providerName"),
222+
type="url",
223+
value=url,
224+
jobId=job_id,
225+
clientName=job.get("clientName"),
226+
providerName=job.get("providerName"),
233227
)
234228
235229
# Add the generated product URL to the job's produced items

0 commit comments

Comments
 (0)